diff --git a/latest/404.html b/latest/404.html index 46654eb321..394a367a78 100644 --- a/latest/404.html +++ b/latest/404.html @@ -591,7 +591,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/clusters/adding-clusters/index.html b/latest/clusters/adding-clusters/index.html index 1e8f08442b..a2bd27a026 100644 --- a/latest/clusters/adding-clusters/index.html +++ b/latest/clusters/adding-clusters/index.html @@ -638,7 +638,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/clusters/removing-clusters/index.html b/latest/clusters/removing-clusters/index.html index c0d691684d..18df0961d9 100644 --- a/latest/clusters/removing-clusters/index.html +++ b/latest/clusters/removing-clusters/index.html @@ -609,7 +609,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/clusters/settings/index.html b/latest/clusters/settings/index.html index 3d59a74edb..f643718478 100644 --- a/latest/clusters/settings/index.html +++ b/latest/clusters/settings/index.html @@ -740,7 +740,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/contributing/development/index.html b/latest/contributing/development/index.html index 71017bab76..a56a1fb305 100644 --- a/latest/contributing/development/index.html +++ b/latest/contributing/development/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -758,6 +758,19 @@ Local Development Environment + +
  • @@ -893,6 +906,19 @@ Local Development Environment + +
  • @@ -949,6 +975,8 @@
  • make dev - builds and starts the app
  • make clean - cleanup local environment build artifacts
  • +

    Developing on Windows#

    +

    On Windows we only support Git Bash (or similar shell) for running commands.

    Github Workflow#

    We Use Github Flow, so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below:

    diff --git a/latest/contributing/documentation/index.html b/latest/contributing/documentation/index.html index 4a637d9da6..c62f171882 100644 --- a/latest/contributing/documentation/index.html +++ b/latest/contributing/documentation/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/contributing/github_workflow/index.html b/latest/contributing/github_workflow/index.html index e3c29c1e4b..f11e9e57b4 100644 --- a/latest/contributing/github_workflow/index.html +++ b/latest/contributing/github_workflow/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/contributing/index.html b/latest/contributing/index.html index cac92ab8c8..7be342c9d5 100644 --- a/latest/contributing/index.html +++ b/latest/contributing/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/contributing/maintainers/index.html b/latest/contributing/maintainers/index.html index 00bc6a52a7..bcced43ed5 100644 --- a/latest/contributing/maintainers/index.html +++ b/latest/contributing/maintainers/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/contributing/promotion/index.html b/latest/contributing/promotion/index.html index 8c9aa1495e..815e30500b 100644 --- a/latest/contributing/promotion/index.html +++ b/latest/contributing/promotion/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/contributing/testing/index.html b/latest/contributing/testing/index.html index b75e3aa0c4..8ccdcceb7c 100644 --- a/latest/contributing/testing/index.html +++ b/latest/contributing/testing/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • 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 5d9bd3c234..c43a4d888f 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1024,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:

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

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

    Protected renderTemplates#

    renderTemplates(folderPath: string): string[]

    -

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

    +

    Defined in src/extensions/cluster-feature.ts: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:

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

    @@ -1131,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 @@ -1158,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:

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

    Object literals#

    status#

    status: object#

    -

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

    +

    Defined in src/extensions/cluster-feature.ts: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 78f650cc03..d75a8e26dc 100644 --- a/latest/extensions/api/classes/_core_api_stores_.cluster/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1006,6 +1006,13 @@ isAdmin + + +
  • + + isGlobalWatchEnabled + +
  • @@ -1179,6 +1186,13 @@ canI +
  • + +
  • + + canUseWatchApi + +
  • @@ -1263,6 +1277,13 @@ init +
  • + +
  • + + isAllowedResource + +
  • @@ -1403,6 +1424,7 @@
  • initialized
  • initializing
  • isAdmin
  • +
  • isGlobalWatchEnabled
  • kubeConfigPath
  • kubeCtl
  • kubeProxyUrl
  • @@ -1430,6 +1452,7 @@
  • activate
  • bindEvents
  • canI
  • +
  • canUseWatchApi
  • disconnect
  • ensureKubectl
  • getAllowedNamespaces
  • @@ -1442,6 +1465,7 @@
  • getProxyKubeconfigPath
  • getState
  • init
  • +
  • isAllowedResource
  • isClusterAdmin
  • k8sRequest
  • pushState
  • @@ -1458,7 +1482,7 @@

    Constructors#

    constructor#

    + new Cluster(model: ClusterModel): Cluster

    -

    Defined in src/main/cluster.ts:249

    +

    Defined in src/main/cluster.ts:255

    Parameters:

    @@ -1478,200 +1502,206 @@

    Properties#

    accessible#

    accessible: boolean = false

    -

    Defined in src/main/cluster.ts:149

    +

    Defined in src/main/cluster.ts:149

    Can user access cluster resources

    observable


    accessibleNamespaces#

    accessibleNamespaces: string[] = []

    Implementation of ClusterModel.accessibleNamespaces

    -

    Defined in src/main/cluster.ts:210

    -

    List of accessible namespaces

    +

    Defined in src/main/cluster.ts:216

    +

    List of accessible namespaces provided by user in the Cluster Settings

    observable


    Protected activated#

    activated: boolean = false

    -

    Defined in src/main/cluster.ts:81

    +

    Defined in src/main/cluster.ts:82


    allowedNamespaces#

    allowedNamespaces: string[] = []

    -

    Defined in src/main/cluster.ts:197

    -

    List of allowed namespaces

    +

    Defined in src/main/cluster.ts:203

    +

    List of allowed namespaces verified via K8S::SelfSubjectAccessReview api

    observable


    allowedResources#

    allowedResources: string[] = []

    -

    Defined in src/main/cluster.ts:204

    +

    Defined in src/main/cluster.ts:210

    List of allowed resources

    observable

    internal


    apiUrl#

    apiUrl: string

    -

    Defined in src/main/cluster.ts:124

    +

    Defined in src/main/cluster.ts:124

    Kubernetes API server URL

    observable


    contextHandler#

    contextHandler: ContextHandler

    -

    Defined in src/main/cluster.ts:72

    +

    Defined in src/main/cluster.ts:73

    Context handler

    internal


    contextName#

    contextName: string

    Implementation of ClusterModel.contextName

    -

    Defined in src/main/cluster.ts:106

    +

    Defined in src/main/cluster.ts:106

    Kubeconfig context name

    observable


    disconnected#

    disconnected: boolean = true

    -

    Defined in src/main/cluster.ts:167

    +

    Defined in src/main/cluster.ts:167

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

    observable


    enabled#

    enabled: boolean = false

    -

    Defined in src/main/cluster.ts:137

    +

    Defined in src/main/cluster.ts:137

    Is cluster instance enabled (disabled clusters are currently hidden)

    observable


    Protected eventDisposers#

    eventDisposers: Function[] = []

    -

    Defined in src/main/cluster.ts:80

    +

    Defined in src/main/cluster.ts:81


    failureReason#

    failureReason: string

    -

    Defined in src/main/cluster.ts:173

    +

    Defined in src/main/cluster.ts:173

    Connection failure reason

    observable


    id#

    id: ClusterId

    Implementation of ClusterModel.id

    -

    Defined in src/main/cluster.ts:60

    +

    Defined in src/main/cluster.ts:61

    Unique id for a cluster


    initialized#

    initialized: boolean = false

    -

    Defined in src/main/cluster.ts:100

    +

    Defined in src/main/cluster.ts:100

    Is cluster object initialized

    observable


    initializing#

    initializing: boolean = false

    -

    Defined in src/main/cluster.ts:92

    +

    Defined in src/main/cluster.ts:93

    Is cluster object initializinng on-going

    observable


    isAdmin#

    isAdmin: boolean = false

    -

    Defined in src/main/cluster.ts:179

    +

    Defined in src/main/cluster.ts:179

    Does user have admin like access

    observable


    +

    isGlobalWatchEnabled#

    +

    isGlobalWatchEnabled: boolean = false

    +

    Defined in src/main/cluster.ts:185

    +

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

    +

    observable

    +

    kubeConfigPath#

    kubeConfigPath: string

    Implementation of ClusterModel.kubeConfigPath

    -

    Defined in src/main/cluster.ts:118

    +

    Defined in src/main/cluster.ts:118

    Path to kubeconfig

    observable


    kubeCtl#

    kubeCtl: Kubectl

    -

    Defined in src/main/cluster.ts:66

    +

    Defined in src/main/cluster.ts:67

    Kubectl

    internal


    kubeProxyUrl#

    kubeProxyUrl: string

    -

    Defined in src/main/cluster.ts:131

    +

    Defined in src/main/cluster.ts:131

    Internal authentication proxy URL

    observable

    internal


    Protected kubeconfigManager#

    kubeconfigManager: KubeconfigManager

    -

    Defined in src/main/cluster.ts:79

    +

    Defined in src/main/cluster.ts:80


    metadata#

    metadata: ClusterMetadata

    Implementation of ClusterModel.metadata

    -

    Defined in src/main/cluster.ts:191

    +

    Defined in src/main/cluster.ts:197

    Metadata

    observable


    online#

    online: boolean = false

    -

    Defined in src/main/cluster.ts:143

    +

    Defined in src/main/cluster.ts:143

    Is cluster online

    observable


    ownerRef#

    ownerRef: string

    Implementation of ClusterModel.ownerRef

    -

    Defined in src/main/cluster.ts:78

    +

    Defined in src/main/cluster.ts:79

    Owner reference

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


    preferences#

    preferences: ClusterPreferences

    Implementation of ClusterModel.preferences

    -

    Defined in src/main/cluster.ts:185

    +

    Defined in src/main/cluster.ts:191

    Preferences

    observable


    ready#

    ready: boolean = false

    -

    Defined in src/main/cluster.ts:155

    +

    Defined in src/main/cluster.ts:155

    Is cluster instance in usable state

    observable


    reconnecting#

    reconnecting: boolean = false

    -

    Defined in src/main/cluster.ts:161

    +

    Defined in src/main/cluster.ts:161

    Is cluster currently reconnecting

    observable


    whenInitialized#

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

    -

    Defined in src/main/cluster.ts:84

    +

    Defined in src/main/cluster.ts:85


    whenReady#

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

    -

    Defined in src/main/cluster.ts:85

    +

    Defined in src/main/cluster.ts:86


    workspace#

    workspace: WorkspaceId

    Implementation of ClusterModel.workspace

    -

    Defined in src/main/cluster.ts:112

    +

    Defined in src/main/cluster.ts:112

    Workspace id

    observable

    Accessors#

    available#

    get available(): boolean

    -

    Defined in src/main/cluster.ts:217

    +

    Defined in src/main/cluster.ts:223

    Is cluster available

    computed

    Returns: boolean


    isManaged#

    get isManaged(): boolean

    -

    Defined in src/main/cluster.ts:263

    +

    Defined in src/main/cluster.ts:269

    Is cluster managed by an extension

    Returns: boolean


    name#

    get name(): string

    -

    Defined in src/main/cluster.ts:226

    +

    Defined in src/main/cluster.ts:232

    Cluster name

    computed

    Returns: string


    prometheusPreferences#

    get prometheusPreferences(): ClusterPrometheusPreferences

    -

    Defined in src/main/cluster.ts:236

    +

    Defined in src/main/cluster.ts:242

    Prometheus preferences

    computed

    internal

    @@ -1679,13 +1709,13 @@

    version#

    get version(): string

    -

    Defined in src/main/cluster.ts:247

    +

    Defined in src/main/cluster.ts:253

    Kubernetes version

    Returns: string

    Methods#

    activate#

    activate(force: boolean): Promise‹void›

    -

    Defined in src/main/cluster.ts:337

    +

    Defined in src/main/cluster.ts:345

    internal

    Parameters:

    @@ -1710,13 +1740,13 @@

    Protected bindEvents#

    bindEvents(): void

    -

    Defined in src/main/cluster.ts:307

    +

    Defined in src/main/cluster.ts:314

    internal

    Returns: void


    canI#

    canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

    -

    Defined in src/main/cluster.ts:538

    +

    Defined in src/main/cluster.ts:560

    internal

    Parameters:

    @@ -1737,41 +1767,64 @@

    Returns: Promise‹boolean›


    +

    canUseWatchApi#

    +

    canUseWatchApi(customizeResource: V1ResourceAttributes): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:592

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    customizeResourceV1ResourceAttributes{}
    +

    Returns: Promise‹boolean›

    +

    disconnect#

    disconnect(): void

    -

    Defined in src/main/cluster.ts:386

    +

    Defined in src/main/cluster.ts:393

    internal

    Returns: void


    Protected ensureKubectl#

    ensureKubectl(): Promise‹boolean›

    -

    Defined in src/main/cluster.ts:367

    +

    Defined in src/main/cluster.ts:373

    internal

    Returns: Promise‹boolean›


    Protected getAllowedNamespaces#

    getAllowedNamespaces(): Promise‹string[]›

    -

    Defined in src/main/cluster.ts:637

    +

    Defined in src/main/cluster.ts:671

    Returns: Promise‹string[]›


    Protected getAllowedResources#

    -

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

    -

    Defined in src/main/cluster.ts:657

    -

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

    +

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

    +

    Defined in src/main/cluster.ts:691

    +

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


    Protected getConnectionStatus#

    getConnectionStatus(): Promise‹ClusterStatus›

    -

    Defined in src/main/cluster.ts:494

    +

    Defined in src/main/cluster.ts:516

    Returns: Promise‹ClusterStatus›


    Protected getKubeconfig#

    getKubeconfig(): KubeConfig

    -

    Defined in src/main/cluster.ts:449

    +

    Defined in src/main/cluster.ts:471

    Returns: KubeConfig


    getMeta#

    getMeta(): object

    -

    Defined in src/main/cluster.ts:625

    +

    Defined in src/main/cluster.ts:659

    Returns: object

    Constructors#

    constructor#

    -

    + new ConfirmDialog(props: Readonly‹ConfirmDialogProps›): ConfirmDialog

    +

    + new ConfirmDialog(props: Readonly‹ConfirmDialogProps› | ConfirmDialogProps): ConfirmDialog

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1279,14 +1279,14 @@ - +
    propsReadonly‹ConfirmDialogPropsReadonly‹ConfirmDialogProps› | ConfirmDialogProps

    Returns: ConfirmDialog

    -

    + new ConfirmDialog(props: ConfirmDialogProps, context?: any): ConfirmDialog

    +

    + new ConfirmDialog(props: ConfirmDialogProps, context: any): ConfirmDialog

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1303,7 +1303,7 @@ ConfirmDialogProps -context? +context any @@ -1313,7 +1313,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1327,17 +1327,17 @@ 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:29


    props#

    props: Readonly‹ConfirmDialogProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1371,21 +1371,21 @@ 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:26


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

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

    Returns: ConfirmDialogParams

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1399,7 +1399,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1434,7 +1434,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1470,13 +1470,13 @@ 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:65

    Returns: void


    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1503,14 +1503,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1554,7 +1554,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹ConfirmDialogProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1588,7 +1588,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1596,7 +1596,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1632,7 +1632,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1641,7 +1641,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1670,24 +1670,24 @@ 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:51

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

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

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1699,7 +1699,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1733,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:36

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

    Parameters:

    @@ -1758,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:40

    icon#

    icon: Element‹› =

    -

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

    +

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

    labelCancel#

    -

    labelCancel: Element‹› = Cancel

    -

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

    +

    labelCancel: string = "Cancel"

    +

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

    labelOk#

    -

    labelOk: Element‹› = Ok

    -

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

    +

    labelOk: string = "Ok"

    +

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

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

    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 93e3c4cff8..d7d664c54c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1104,9 +1104,9 @@

    Constructors#

    constructor#

    -

    + new CubeSpinner(props: Readonly‹CubeSpinnerProps›): CubeSpinner

    +

    + new CubeSpinner(props: Readonly‹CubeSpinnerProps› | CubeSpinnerProps): CubeSpinner

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1118,14 +1118,14 @@ - +
    propsReadonly‹CubeSpinnerPropsReadonly‹CubeSpinnerProps› | CubeSpinnerProps

    Returns: CubeSpinner

    -

    + new CubeSpinner(props: CubeSpinnerProps, context?: any): CubeSpinner

    +

    + new CubeSpinner(props: CubeSpinnerProps, context: any): CubeSpinner

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1142,7 +1142,7 @@ CubeSpinnerProps -context? +context any @@ -1152,7 +1152,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1167,12 +1167,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹CubeSpinnerProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1207,7 +1207,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1221,7 +1221,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1293,7 +1293,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1320,14 +1320,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1371,7 +1371,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹CubeSpinnerProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1405,7 +1405,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1413,7 +1413,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1449,7 +1449,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1488,13 +1488,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1506,7 +1506,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 8f12b0d16f..5051c88d16 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1235,22 +1235,22 @@

    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#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1264,7 +1264,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1299,7 +1299,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1335,13 +1335,13 @@ 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#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

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

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1408,7 +1408,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹DialogProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1442,13 +1442,13 @@ 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#

    componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

    Inherited from PageLayout.componentWillUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1484,7 +1484,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

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

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

    @@ -1558,23 +1558,23 @@ 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#

    shouldComponentUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): boolean

    Inherited from PageLayout.shouldComponentUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Defined in node_modules/@types/react/index.d.ts:630

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

    @@ -1628,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 b8a93e3164..da6ae6874a 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1160,9 +1160,9 @@

    Constructors#

    constructor#

    -

    + new Drawer(props: Readonly‹DrawerProps›): Drawer

    +

    + new Drawer(props: Readonly‹DrawerProps› | DrawerProps): Drawer

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1174,14 +1174,14 @@ - +
    propsReadonly‹DrawerPropsReadonly‹DrawerProps› | DrawerProps

    Returns: Drawer

    -

    + new Drawer(props: DrawerProps, context?: any): Drawer

    +

    + new Drawer(props: DrawerProps, context: any): Drawer

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1198,7 +1198,7 @@ DrawerProps -context? +context any @@ -1208,7 +1208,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1223,12 +1223,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹DrawerProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1262,12 +1262,12 @@ 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

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1281,7 +1281,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1316,7 +1316,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1352,13 +1352,13 @@ 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#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1385,13 +1385,13 @@ 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#

    componentDidUpdate(prevProps: Readonly‹DrawerProps›, prevState: Readonly‹S›, snapshot?: SS): void

    Inherited from PageLayout.componentDidUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1435,7 +1435,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹DrawerProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1469,13 +1469,13 @@ 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#

    componentWillUpdate(nextProps: Readonly‹DrawerProps›, nextState: Readonly‹S›, nextContext: any): void

    Inherited from PageLayout.componentWillUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1511,7 +1511,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1520,7 +1520,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

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

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

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

    @@ -1610,23 +1610,23 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1638,7 +1638,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 f98e541b30..898bf513f1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1104,9 +1104,9 @@

    Constructors#

    constructor#

    -

    + new DrawerItem(props: Readonly‹DrawerItemProps›): DrawerItem

    +

    + new DrawerItem(props: Readonly‹DrawerItemProps› | DrawerItemProps): DrawerItem

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1118,14 +1118,14 @@ - +
    propsReadonly‹DrawerItemPropsReadonly‹DrawerItemProps› | DrawerItemProps

    Returns: DrawerItem

    -

    + new DrawerItem(props: DrawerItemProps, context?: any): DrawerItem

    +

    + new DrawerItem(props: DrawerItemProps, context: any): DrawerItem

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1142,7 +1142,7 @@ DrawerItemProps -context? +context any @@ -1152,7 +1152,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1167,12 +1167,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹DrawerItemProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1207,7 +1207,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1221,7 +1221,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1293,7 +1293,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1320,14 +1320,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1371,7 +1371,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹DrawerItemProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1405,7 +1405,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1413,7 +1413,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1449,7 +1449,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1488,13 +1488,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1506,7 +1506,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 a1ccbd84b8..28e63a21b6 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1110,9 +1110,9 @@

    Constructors#

    constructor#

    -

    + new DrawerParamToggler(props: Readonly‹DrawerParamTogglerProps›): DrawerParamToggler

    +

    + new DrawerParamToggler(props: Readonly‹DrawerParamTogglerProps› | DrawerParamTogglerProps): DrawerParamToggler

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1124,14 +1124,14 @@ - +
    propsReadonly‹DrawerParamTogglerPropsReadonly‹DrawerParamTogglerProps› | DrawerParamTogglerProps

    Returns: DrawerParamToggler

    -

    + new DrawerParamToggler(props: DrawerParamTogglerProps, context?: any): DrawerParamToggler

    +

    + new DrawerParamToggler(props: DrawerParamTogglerProps, context: any): DrawerParamToggler

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1148,7 +1148,7 @@ DrawerParamTogglerProps -context? +context any @@ -1158,7 +1158,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1173,12 +1173,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹DrawerParamTogglerProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

    @@ -1189,12 +1189,12 @@ 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:14


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1213,7 +1213,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1227,7 +1227,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1262,7 +1262,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1299,7 +1299,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1326,14 +1326,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1377,7 +1377,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹DrawerParamTogglerProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1411,7 +1411,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1419,7 +1419,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1455,7 +1455,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1464,7 +1464,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1494,13 +1494,13 @@ 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:20

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof State

    Parameters:

    @@ -1512,7 +1512,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1546,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:16

    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 16c0bb757c..b64cb5be37 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1104,9 +1104,9 @@

    Constructors#

    constructor#

    -

    + new DrawerTitle(props: Readonly‹DrawerTitleProps›): DrawerTitle

    +

    + new DrawerTitle(props: Readonly‹DrawerTitleProps› | DrawerTitleProps): DrawerTitle

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1118,14 +1118,14 @@ - +
    propsReadonly‹DrawerTitlePropsReadonly‹DrawerTitleProps› | DrawerTitleProps

    Returns: DrawerTitle

    -

    + new DrawerTitle(props: DrawerTitleProps, context?: any): DrawerTitle

    +

    + new DrawerTitle(props: DrawerTitleProps, context: any): DrawerTitle

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1142,7 +1142,7 @@ DrawerTitleProps -context? +context any @@ -1152,7 +1152,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1167,12 +1167,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹DrawerTitleProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1207,7 +1207,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1221,7 +1221,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1293,7 +1293,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1320,14 +1320,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1371,7 +1371,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹DrawerTitleProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1405,7 +1405,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1413,7 +1413,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1449,7 +1449,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1488,13 +1488,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1506,7 +1506,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 c6a6bfdcd0..4ff11ea3fb 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.icon/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1086,13 +1086,13 @@

    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#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1106,7 +1106,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1141,7 +1141,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1178,7 +1178,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1205,14 +1205,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹IconProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1290,7 +1290,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1298,7 +1298,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1334,7 +1334,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

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

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

    @@ -1403,13 +1403,13 @@ 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#

    shouldComponentUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): boolean

    Inherited from PageLayout.shouldComponentUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1443,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 4b228b1aad..3f2f1bb4e3 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.input/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.input/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1328,9 +1328,9 @@

    Constructors#

    constructor#

    -

    + new Input(props: Readonly‹InputProps›): Input

    +

    + new Input(props: Readonly‹InputProps› | InputProps): Input

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1342,14 +1342,14 @@ - +
    propsReadonly‹InputPropsReadonly‹InputProps› | InputProps

    Returns: Input

    -

    + new Input(props: InputProps, context?: any): Input

    +

    + new Input(props: InputProps, context: any): Input

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1366,7 +1366,7 @@ InputProps -context? +context any @@ -1376,7 +1376,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1390,17 +1390,17 @@ 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›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

    @@ -1410,12 +1410,12 @@ 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›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1433,22 +1433,22 @@ 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#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1462,7 +1462,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1497,7 +1497,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

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

    @@ -1553,13 +1553,13 @@ 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#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

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

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1626,7 +1626,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹InputProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1660,7 +1660,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1668,7 +1668,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1703,13 +1703,13 @@ 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#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1718,7 +1718,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

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

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

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

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

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

    @@ -1871,7 +1871,7 @@ lifecycle events from running.

    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof State

    Parameters:

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

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

    @@ -1923,7 +1923,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

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

    @@ -1980,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 7e8e7e37f6..d2202ecfb6 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1104,9 +1104,9 @@

    Constructors#

    constructor#

    -

    + new KubeEventDetails(props: Readonly‹KubeEventDetailsProps›): KubeEventDetails

    +

    + new KubeEventDetails(props: Readonly‹KubeEventDetailsProps› | KubeEventDetailsProps): KubeEventDetails

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1118,14 +1118,14 @@ - +
    propsReadonly‹KubeEventDetailsPropsReadonly‹KubeEventDetailsProps› | KubeEventDetailsProps

    Returns: KubeEventDetails

    -

    + new KubeEventDetails(props: KubeEventDetailsProps, context?: any): KubeEventDetails

    +

    + new KubeEventDetails(props: KubeEventDetailsProps, context: any): KubeEventDetails

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1142,7 +1142,7 @@ KubeEventDetailsProps -context? +context any @@ -1152,7 +1152,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1167,12 +1167,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹KubeEventDetailsProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1207,7 +1207,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1221,7 +1221,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1293,7 +1293,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1320,13 +1320,13 @@ 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:16

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1370,7 +1370,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹KubeEventDetailsProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1404,7 +1404,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1412,7 +1412,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1448,7 +1448,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1487,13 +1487,13 @@ 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:20

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1505,7 +1505,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 1f83ec8781..86feb4d2b4 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1177,9 +1177,9 @@

    Constructors#

    constructor#

    -

    + new KubeObjectDetails(props: Readonly‹P›): KubeObjectDetails

    +

    + new KubeObjectDetails(props: Readonly‹P› | P): KubeObjectDetails

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1191,14 +1191,14 @@ - +
    propsReadonly‹P›Readonly‹P› | P

    Returns: KubeObjectDetails

    -

    + new KubeObjectDetails(props: P, context?: any): KubeObjectDetails

    +

    + new KubeObjectDetails(props: P, context: any): KubeObjectDetails

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1215,7 +1215,7 @@ P -context? +context any @@ -1225,7 +1225,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1239,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:60


    loader#

    loader: IReactionDisposer = reaction(() => [ @@ -1258,7 +1258,7 @@ Should be used with type annotation or static contextType.

    try { await store.loadFromPath(path); } catch (err) { - this.loadingError = <Trans>Resource loading has failed: <b>{err.toString()}</b></Trans>; + this.loadingError = <>Resource loading has failed: <b>{err.toString()}</b>; } finally { this.isLoading = false; } @@ -1266,21 +1266,21 @@ 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:80


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


    props#

    props: Readonly‹P› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1314,23 +1314,23 @@ 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:75

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

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

    Returns: string

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1344,7 +1344,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1379,7 +1379,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1416,7 +1416,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1443,14 +1443,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1494,7 +1494,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1528,7 +1528,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1536,7 +1536,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1572,7 +1572,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1581,7 +1581,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1611,13 +1611,13 @@ 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:105

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1629,7 +1629,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 8a786e642c..bc6784a5d5 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -993,8 +993,8 @@
  • - - Optional componentDidMount + + componentDidMount
  • @@ -1128,7 +1128,7 @@
  • UNSAFE_componentWillReceiveProps
  • UNSAFE_componentWillUpdate
  • componentDidCatch
  • -
  • componentDidMount
  • +
  • componentDidMount
  • componentDidUpdate
  • componentWillMount
  • componentWillReceiveProps
  • @@ -1143,9 +1143,9 @@

    Constructors#

    constructor#

    -

    + new KubeObjectListLayout(props: Readonly‹KubeObjectListLayoutProps›): KubeObjectListLayout

    +

    + new KubeObjectListLayout(props: Readonly‹KubeObjectListLayoutProps› | KubeObjectListLayoutProps): KubeObjectListLayout

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1157,14 +1157,14 @@ - +
    propsReadonly‹KubeObjectListLayoutPropsReadonly‹KubeObjectListLayoutProps› | KubeObjectListLayoutProps

    Returns: KubeObjectListLayout

    -

    + new KubeObjectListLayout(props: KubeObjectListLayoutProps, context?: any): KubeObjectListLayout

    +

    + new KubeObjectListLayout(props: KubeObjectListLayoutProps, context: any): KubeObjectListLayout

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1181,7 +1181,7 @@ KubeObjectListLayoutProps -context? +context any @@ -1191,7 +1191,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1206,12 +1206,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹KubeObjectListLayoutProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1245,13 +1245,13 @@ 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:20

    Returns: any

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1265,7 +1265,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1300,7 +1300,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1337,7 +1337,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1361,17 +1361,16 @@ the entire component tree to unmount.

    Returns: void


    -

    Optional componentDidMount#

    +

    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.

    +

    Overrides WizardLayout.componentDidMount

    +

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

    @@ -1402,7 +1401,7 @@ the entire component tree to unmount.

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1415,7 +1414,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹KubeObjectListLayoutProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1449,7 +1448,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1457,7 +1456,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1493,7 +1492,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1502,7 +1501,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1531,7 +1530,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:36

    Parameters:

    @@ -1552,13 +1551,13 @@ 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:44

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 2b8f943708..9e5f6d7fdb 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1175,9 +1175,9 @@

    Constructors#

    constructor#

    -

    + new KubeObjectMenu(props: Readonly‹KubeObjectMenuProps›): KubeObjectMenu

    +

    + new KubeObjectMenu(props: Readonly‹KubeObjectMenuProps› | KubeObjectMenuProps): KubeObjectMenu

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1189,14 +1189,14 @@ - +
    propsReadonly‹KubeObjectMenuPropsReadonly‹KubeObjectMenuProps› | KubeObjectMenuProps

    Returns: KubeObjectMenu

    -

    + new KubeObjectMenu(props: KubeObjectMenuProps, context?: any): KubeObjectMenu

    +

    + new KubeObjectMenu(props: KubeObjectMenuProps, context: any): KubeObjectMenu

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1213,7 +1213,7 @@ KubeObjectMenuProps -context? +context any @@ -1223,7 +1223,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1238,12 +1238,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹KubeObjectMenuProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1277,23 +1277,23 @@ 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:25

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

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1307,7 +1307,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1342,7 +1342,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1379,7 +1379,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1406,14 +1406,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1457,7 +1457,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹KubeObjectMenuProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1491,7 +1491,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1499,7 +1499,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1535,7 +1535,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1544,7 +1544,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1573,24 +1573,24 @@ 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:44

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

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

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1602,7 +1602,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1636,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:38

    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 4e3672ca79..f25d480cff 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1120,9 +1120,9 @@

    Constructors#

    constructor#

    -

    + new KubeObjectMeta(props: Readonly‹KubeObjectMetaProps›): KubeObjectMeta

    +

    + new KubeObjectMeta(props: Readonly‹KubeObjectMetaProps› | KubeObjectMetaProps): KubeObjectMeta

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1134,14 +1134,14 @@ - +
    propsReadonly‹KubeObjectMetaPropsReadonly‹KubeObjectMetaProps› | KubeObjectMetaProps

    Returns: KubeObjectMeta

    -

    + new KubeObjectMeta(props: KubeObjectMetaProps, context?: any): KubeObjectMeta

    +

    + new KubeObjectMeta(props: KubeObjectMetaProps, context: any): KubeObjectMeta

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1158,7 +1158,7 @@ KubeObjectMetaProps -context? +context any @@ -1168,7 +1168,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1183,12 +1183,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹KubeObjectMetaProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1224,12 +1224,12 @@ 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:15

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1243,7 +1243,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1278,7 +1278,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1315,7 +1315,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1342,14 +1342,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1393,7 +1393,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹KubeObjectMetaProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1427,7 +1427,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1435,7 +1435,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1471,7 +1471,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1480,7 +1480,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1509,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:19

    Parameters:

    @@ -1530,13 +1530,13 @@ 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:25

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1548,7 +1548,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 7185cf09bc..f43963c5aa 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1061,7 +1061,7 @@

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1075,7 +1075,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1110,7 +1110,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1147,7 +1147,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1174,14 +1174,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1225,7 +1225,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹LineProgressProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1259,7 +1259,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1267,7 +1267,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1303,7 +1303,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1332,13 +1332,13 @@ 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#

    shouldComponentUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): boolean

    Inherited from PageLayout.shouldComponentUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1372,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 29e9348970..89749b0898 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menu/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1130,6 +1130,13 @@ onClickOutside + + +
  • + + onContextMenu + +
  • @@ -1258,6 +1265,7 @@
  • forceUpdate
  • getSnapshotBeforeUpdate
  • onClickOutside
  • +
  • onContextMenu
  • onKeyDown
  • onScrollOutside
  • onWindowResize
  • @@ -1269,9 +1277,9 @@

    Constructors#

    constructor#

    -

    + new Menu(props: Readonly‹MenuProps›): Menu

    +

    + new Menu(props: Readonly‹MenuProps› | MenuProps): Menu

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1283,14 +1291,14 @@ - +
    propsReadonly‹MenuPropsReadonly‹MenuProps› | MenuProps

    Returns: Menu

    -

    + new Menu(props: MenuProps, context?: any): Menu

    +

    + new Menu(props: MenuProps, context: any): Menu

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1307,7 +1315,7 @@ MenuProps -context? +context any @@ -1317,7 +1325,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1331,11 +1339,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:56


    Protected items#

    items: object

    -

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

    +

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

    Type declaration:

    • [ index: number]: MenuItem
    • @@ -1343,12 +1351,12 @@ Should be used with type annotation or static contextType.


      opener#

      opener: HTMLElement

      -

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

      +

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


      props#

      props: Readonly‹MenuProps› & Readonly‹object›

      Inherited from PageLayout.props

      -

      Defined in node_modules/@types/react/index.d.ts:511

      +

      Defined in node_modules/@types/react/index.d.ts:498


      refreshPosition#

      refreshPosition: (Anonymous function) & Cancelable = debounce(() => { @@ -1387,12 +1395,12 @@ if (menuPos.bottom > window.innerHeight) { this.setState({ position });

    }, Animate.VISIBILITY_DELAY_MS)

    -

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

    +

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


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

    @@ -1403,12 +1411,12 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    state#

    state: State

    Overrides PageLayout.state

    -

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

    +

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


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1426,27 +1434,27 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs


    Static defaultProps#

    defaultProps: object = defaultPropsMenu as object

    -

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

    +

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

    Accessors#

    Protected focusableItems#

    get focusableItems(): MenuItem‹›[]

    -

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

    +

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

    Returns: MenuItem‹›[]


    Protected focusedItem#

    get focusedItem(): MenuItem‹›

    -

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

    +

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

    Returns: MenuItem‹›


    isOpen#

    get isOpen(): boolean

    -

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

    +

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

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1460,7 +1468,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1495,7 +1503,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1531,7 +1539,7 @@ prevents this from being invoked.


    Protected bindItemRef#

    bindItemRef(item: MenuItem, index: number): void

    -

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

    +

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

    Parameters:

    @@ -1555,7 +1563,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:235

    Parameters:

    @@ -1575,13 +1583,13 @@ 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:168

    Returns: void


    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1608,13 +1616,13 @@ 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:65

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

    @@ -1645,7 +1653,7 @@ the entire component tree to unmount.

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1658,7 +1666,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹MenuProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1692,13 +1700,13 @@ 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:87

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1733,7 +1741,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:106

    Parameters:

    @@ -1756,7 +1764,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1765,7 +1773,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1794,7 +1802,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:223

    Parameters:

    @@ -1812,9 +1820,14 @@ lifecycle events from running.

    Returns: void


    +

    onContextMenu#

    +

    onContextMenu(): void

    +

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

    +

    Returns: void

    +

    onKeyDown#

    onKeyDown(evt: KeyboardEvent): void

    -

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

    +

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

    Parameters:

    @@ -1834,7 +1847,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:213

    Parameters:

    @@ -1854,24 +1867,24 @@ lifecycle events from running.


    onWindowResize#

    onWindowResize(): void

    -

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

    +

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

    Returns: void


    open#

    open(): void

    -

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

    +

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

    Returns: void


    render#

    render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof State

    Parameters:

    @@ -1883,7 +1896,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1917,7 +1930,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:173

    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 6f00d4193c..f7a3aa4474 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1189,9 +1189,9 @@

    Constructors#

    constructor#

    -

    + new MenuActions(props: Readonly‹MenuActionsProps›): MenuActions

    +

    + new MenuActions(props: Readonly‹MenuActionsProps› | MenuActionsProps): MenuActions

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1203,14 +1203,14 @@ - +
    propsReadonly‹MenuActionsPropsReadonly‹MenuActionsProps› | MenuActionsProps

    Returns: MenuActions

    -

    + new MenuActions(props: MenuActionsProps, context?: any): MenuActions

    +

    + new MenuActions(props: MenuActionsProps, context: any): MenuActions

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1227,7 +1227,7 @@ MenuActionsProps -context? +context any @@ -1237,7 +1237,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1251,21 +1251,21 @@ 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:31


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


    props#

    props: Readonly‹MenuActionsProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1300,7 +1300,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1314,7 +1314,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1349,7 +1349,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

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

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1413,14 +1413,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1464,7 +1464,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹MenuActionsProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

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

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1506,7 +1506,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1542,7 +1542,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1551,7 +1551,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1580,24 +1580,24 @@ 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:41

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

    Returns: Element‹›


    renderTriggerIcon#

    renderTriggerIcon(): Element‹›

    -

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

    +

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

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1609,7 +1609,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1643,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:35

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

    removeConfirmationMessage#

    removeConfirmationMessage:

    -

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

    +

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

    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 a832844e49..3cecd94aaa 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1175,9 +1175,9 @@

    Constructors#

    constructor#

    -

    + new MenuItem(props: Readonly‹MenuItemProps›): MenuItem

    +

    + new MenuItem(props: Readonly‹MenuItemProps› | MenuItemProps): MenuItem

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1189,14 +1189,14 @@ - +
    propsReadonly‹MenuItemPropsReadonly‹MenuItemProps› | MenuItemProps

    Returns: MenuItem

    -

    + new MenuItem(props: MenuItemProps, context?: any): MenuItem

    +

    + new MenuItem(props: MenuItemProps, context: any): MenuItem

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1213,7 +1213,7 @@ MenuItemProps -context? +context any @@ -1223,21 +1223,21 @@

    context#

    context: MenuContextValue

    Overrides PageLayout.context

    -

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

    +

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


    elem#

    elem: HTMLElement

    -

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

    +

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


    props#

    props: Readonly‹MenuItemProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


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


    Static defaultProps#

    defaultProps: object = defaultPropsMenuItem as object

    -

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

    +

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

    Accessors#

    isFocusable#

    get isFocusable(): boolean

    -

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

    +

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

    Returns: boolean


    get isLink(): boolean

    -

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

    +

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

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1286,7 +1286,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1321,7 +1321,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1357,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:339

    Parameters:

    @@ -1378,7 +1378,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1405,14 +1405,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1456,7 +1456,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹MenuItemProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1490,7 +1490,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1498,7 +1498,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1534,7 +1534,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1572,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:327

    Parameters:

    @@ -1593,13 +1593,13 @@ 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:343

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 diff --git a/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html b/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html new file mode 100644 index 0000000000..b1b66cf3bf --- /dev/null +++ b/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html @@ -0,0 +1,1691 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceSelect ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: NamespaceSelect ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    +
      +
    • Component‹Props›
    • +
    +

    NamespaceSelect

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NamespaceSelect(props: Readonly‹Props› | Props): NamespaceSelect

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    propsReadonly‹Props› | Props
    +

    Returns: NamespaceSelect

    +

    + new NamespaceSelect(props: Props, context: any): NamespaceSelect

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsProps
    contextany
    +

    Returns: NamespaceSelect

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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‹Props› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

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

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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/+namespaces/namespace-select.tsx:26

    +

    Accessors#

    +

    options#

    +

    get options(): SelectOption[]

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:36

    +

    Returns: SelectOption[]

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    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‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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‹Props›
    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:640

    +

    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/+namespaces/namespace-select.tsx:28

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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‹Props›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    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‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    formatOptionLabel#

    +

    formatOptionLabel(option: SelectOption): object

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionSelectOption
    +

    Returns: object

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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‹Props›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:65

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + + +
    +
    + + + + + +
    + + + + + + + + + \ No newline at end of file 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 7bcb666657..f6bb4a9461 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1154,9 +1154,9 @@

    Constructors#

    constructor#

    -

    + new Notifications(props: Readonly‹P›): Notifications

    +

    + new Notifications(props: Readonly‹P› | P): Notifications

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1168,14 +1168,14 @@ - +
    propsReadonly‹P›Readonly‹P› | P

    Returns: Notifications

    -

    + new Notifications(props: P, context?: any): Notifications

    +

    + new Notifications(props: P, context: any): Notifications

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1192,7 +1192,7 @@ P -context? +context any @@ -1202,7 +1202,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1216,17 +1216,17 @@ 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›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1261,7 +1261,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1275,7 +1275,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1310,7 +1310,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1347,7 +1347,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1374,13 +1374,13 @@ 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#

    componentDidUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›, snapshot?: SS): void

    Inherited from PageLayout.componentDidUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1424,7 +1424,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

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

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1466,7 +1466,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1502,7 +1502,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    @@ -1531,7 +1531,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1561,18 +1561,18 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1584,7 +1584,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

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

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

    @@ -1666,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 cd343a2db4..6daea877eb 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -958,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.tsx:28


    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.tsx:26

    Methods#

    add#

    add(notification: Notification): function

    -

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

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:55

    Parameters:

    @@ -987,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.tsx:34

    Parameters:

    @@ -1007,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.tsx:30

    Parameters:

    @@ -1027,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.tsx:72

    Parameters:

    @@ -1047,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.tsx:47

    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 53c0d05dd6..8e71b651f3 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1128,9 +1128,9 @@

    Constructors#

    constructor#

    -

    + new PageLayout(props: Readonly‹PageLayoutProps›): PageLayout

    +

    + new PageLayout(props: Readonly‹PageLayoutProps› | PageLayoutProps): PageLayout

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1142,14 +1142,14 @@ - +
    propsReadonly‹PageLayoutPropsReadonly‹PageLayoutProps› | PageLayoutProps

    Returns: PageLayout

    -

    + new PageLayout(props: PageLayoutProps, context?: any): PageLayout

    +

    + new PageLayout(props: PageLayoutProps, context: any): PageLayout

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1166,7 +1166,7 @@ PageLayoutProps -context? +context any @@ -1176,7 +1176,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1191,12 +1191,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹PageLayoutProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1230,12 +1230,12 @@ 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

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1249,7 +1249,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1284,7 +1284,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

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

    @@ -1341,7 +1341,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1368,13 +1368,13 @@ 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#

    componentDidUpdate(prevProps: Readonly‹PageLayoutProps›, prevState: Readonly‹S›, snapshot?: SS): void

    Inherited from PageLayout.componentDidUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1418,7 +1418,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹PageLayoutProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1452,13 +1452,13 @@ 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#

    componentWillUpdate(nextProps: Readonly‹PageLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    Inherited from PageLayout.componentWillUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1494,7 +1494,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1503,7 +1503,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

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

    @@ -1553,13 +1553,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1571,7 +1571,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 diff --git a/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html b/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html new file mode 100644 index 0000000000..e18bcaafd5 --- /dev/null +++ b/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html @@ -0,0 +1,1757 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDetailsList ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: PodDetailsList ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    +
      +
    • Component‹Props›
    • +
    +

    PodDetailsList

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodDetailsList(props: Readonly‹Props› | Props): PodDetailsList

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    propsReadonly‹Props› | Props
    +

    Returns: PodDetailsList

    +

    + new PodDetailsList(props: Props, context: any): PodDetailsList

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsProps
    contextany
    +

    Returns: PodDetailsList

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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‹Props› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

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

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

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

    +

    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‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    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‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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‹Props›
    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:640

    +

    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/+workloads-pods/pod-details-list.tsx:53

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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‹Props›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    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‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:60

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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‹Props›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    getTableRow#

    +

    getTableRow(uid: string): Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    uidstring
    +

    Returns: Element‹›

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:125

    +

    Returns: Element‹›

    +
    +

    renderCpuUsage#

    +

    renderCpuUsage(id: string, usage: number): string | 0 | Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:64

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    usagenumber
    +

    Returns: string | 0 | Element‹›

    +
    +

    renderMemoryUsage#

    +

    renderMemoryUsage(id: string, usage: number): string | 0 | Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:85

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    usagenumber
    +

    Returns: string | 0 | Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:38

    +

    showTitle#

    +

    showTitle: true = true

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:39

    + + + + + + + + +
    +
    + + + + + +
    + + + + + + + + + \ No newline at end of file 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 394e40b03d..b95b371f7a 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.radio/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1120,9 +1120,9 @@

    Constructors#

    constructor#

    -

    + new Radio(props: Readonly‹RadioProps›): Radio

    +

    + new Radio(props: Readonly‹RadioProps› | RadioProps): Radio

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1134,14 +1134,14 @@ - +
    propsReadonly‹RadioPropsReadonly‹RadioProps› | RadioProps

    Returns: Radio

    -

    + new Radio(props: RadioProps, context?: any): Radio

    +

    + new Radio(props: RadioProps, context: any): Radio

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1158,7 +1158,7 @@ RadioProps -context? +context any @@ -1168,7 +1168,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1183,12 +1183,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹RadioProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1223,7 +1223,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1237,7 +1237,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1272,7 +1272,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1309,7 +1309,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1336,14 +1336,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1387,7 +1387,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹RadioProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1421,7 +1421,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1429,7 +1429,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1465,7 +1465,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1474,7 +1474,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

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

    @@ -1529,13 +1529,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1547,7 +1547,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 ef7ee5ee91..c87c53532b 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1102,9 +1102,9 @@

    Constructors#

    constructor#

    -

    + new RadioGroup(props: Readonly‹RadioGroupProps›): RadioGroup

    +

    + new RadioGroup(props: Readonly‹RadioGroupProps› | RadioGroupProps): RadioGroup

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1116,14 +1116,14 @@ - +
    propsReadonly‹RadioGroupPropsReadonly‹RadioGroupProps› | RadioGroupProps

    Returns: RadioGroup

    -

    + new RadioGroup(props: RadioGroupProps, context?: any): RadioGroup

    +

    + new RadioGroup(props: RadioGroupProps, context: any): RadioGroup

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1140,7 +1140,7 @@ RadioGroupProps -context? +context any @@ -1150,7 +1150,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1165,12 +1165,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹RadioGroupProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹object›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1205,7 +1205,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1219,7 +1219,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1254,7 +1254,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1291,7 +1291,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1318,14 +1318,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1369,7 +1369,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹RadioGroupProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1403,7 +1403,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1411,7 +1411,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1447,7 +1447,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1456,7 +1456,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1486,13 +1486,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof object

    Parameters:

    @@ -1504,7 +1504,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 24177758c9..3c5624e2b1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.select/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.select/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1234,9 +1234,9 @@

    Constructors#

    constructor#

    -

    + new Select(props: Readonly‹SelectProps›): Select

    +

    + new Select(props: Readonly‹SelectProps› | SelectProps): Select

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1248,14 +1248,14 @@ - +
    propsReadonly‹SelectPropsReadonly‹SelectProps› | SelectProps

    Returns: Select

    -

    + new Select(props: SelectProps, context?: any): Select

    +

    + new Select(props: SelectProps, context: any): Select

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1272,7 +1272,7 @@ SelectProps -context? +context any @@ -1282,7 +1282,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1297,12 +1297,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹SelectProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1336,23 +1336,23 @@ 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#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1366,7 +1366,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1401,7 +1401,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1438,7 +1438,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1465,14 +1465,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1516,7 +1516,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1550,7 +1550,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1558,7 +1558,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1594,7 +1594,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1603,7 +1603,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

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

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

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

    @@ -1697,13 +1697,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1715,7 +1715,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1749,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 a19a213574..22a94abaed 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.slider/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1112,9 +1112,9 @@

    Constructors#

    constructor#

    -

    + new Slider(props: Readonly‹SliderProps›): Slider

    +

    + new Slider(props: Readonly‹SliderProps› | SliderProps): Slider

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1126,14 +1126,14 @@ - +
    propsReadonly‹SliderPropsReadonly‹SliderProps› | SliderProps

    Returns: Slider

    -

    + new Slider(props: SliderProps, context?: any): Slider

    +

    + new Slider(props: SliderProps, context: any): Slider

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1150,7 +1150,7 @@ SliderProps -context? +context any @@ -1160,7 +1160,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1175,12 +1175,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹SliderProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1214,12 +1214,12 @@ 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

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1233,7 +1233,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1268,7 +1268,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1305,7 +1305,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1332,14 +1332,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1383,7 +1383,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹SliderProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1417,7 +1417,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1425,7 +1425,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1461,7 +1461,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1500,13 +1500,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 0c82ab7059..3999ac95b2 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1154,9 +1154,9 @@

    Constructors#

    constructor#

    -

    + new Spinner(props: Readonly‹SpinnerProps›): Spinner

    +

    + new Spinner(props: Readonly‹SpinnerProps› | SpinnerProps): Spinner

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1168,14 +1168,14 @@ - +
    propsReadonly‹SpinnerPropsReadonly‹SpinnerProps› | SpinnerProps

    Returns: Spinner

    -

    + new Spinner(props: SpinnerProps, context?: any): Spinner

    +

    + new Spinner(props: SpinnerProps, context: any): Spinner

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1192,7 +1192,7 @@ SpinnerProps -context? +context any @@ -1202,7 +1202,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1217,12 +1217,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹SpinnerProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹object›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1257,7 +1257,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1271,7 +1271,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1306,7 +1306,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1343,7 +1343,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1370,14 +1370,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1421,7 +1421,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹SpinnerProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1455,7 +1455,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1463,7 +1463,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1499,7 +1499,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1508,7 +1508,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1538,13 +1538,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof object

    Parameters:

    @@ -1556,7 +1556,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1590,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 0590a60e7a..ab98608002 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1104,9 +1104,9 @@

    Constructors#

    constructor#

    -

    + new StatusBrick(props: Readonly‹StatusBrickProps›): StatusBrick

    +

    + new StatusBrick(props: Readonly‹StatusBrickProps› | StatusBrickProps): StatusBrick

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1118,14 +1118,14 @@ - +
    propsReadonly‹StatusBrickPropsReadonly‹StatusBrickProps› | StatusBrickProps

    Returns: StatusBrick

    -

    + new StatusBrick(props: StatusBrickProps, context?: any): StatusBrick

    +

    + new StatusBrick(props: StatusBrickProps, context: any): StatusBrick

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1142,7 +1142,7 @@ StatusBrickProps -context? +context any @@ -1152,7 +1152,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1167,12 +1167,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹StatusBrickProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1207,7 +1207,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1221,7 +1221,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1293,7 +1293,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1320,14 +1320,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1371,7 +1371,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹StatusBrickProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1405,7 +1405,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1413,7 +1413,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1449,7 +1449,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1488,13 +1488,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1506,7 +1506,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 e011551cca..52fd415f64 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1102,9 +1102,9 @@

    Constructors#

    constructor#

    -

    + new Stepper(props: Readonly‹StepperProps›): Stepper

    +

    + new Stepper(props: Readonly‹StepperProps› | StepperProps): Stepper

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1116,14 +1116,14 @@ - +
    propsReadonly‹StepperPropsReadonly‹StepperProps› | StepperProps

    Returns: Stepper

    -

    + new Stepper(props: StepperProps, context?: any): Stepper

    +

    + new Stepper(props: StepperProps, context: any): Stepper

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1140,7 +1140,7 @@ StepperProps -context? +context any @@ -1150,7 +1150,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1165,12 +1165,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹StepperProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹object›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1205,7 +1205,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1219,7 +1219,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1254,7 +1254,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1291,7 +1291,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1318,14 +1318,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1369,7 +1369,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹StepperProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1403,7 +1403,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1411,7 +1411,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1447,7 +1447,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1456,7 +1456,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1486,13 +1486,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof object

    Parameters:

    @@ -1504,7 +1504,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 5a4da22151..75bdfb4cbd 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tab/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1120,25 +1120,25 @@

    Properties#

    context#

    context: TabsContextValue

    -

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

    +

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


    elem#

    elem: HTMLElement

    -

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

    +

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


    Static contextType#

    contextType: Context‹TabsContextValue‹any›› = TabsContext

    -

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

    +

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

    Accessors#

    isActive#

    get isActive(): boolean

    -

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

    +

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

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1152,7 +1152,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1187,7 +1187,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1223,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:121

    Parameters:

    @@ -1244,7 +1244,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1271,13 +1271,13 @@ 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:114

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1321,7 +1321,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹TabProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1355,7 +1355,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1363,7 +1363,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1398,13 +1398,13 @@ 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:74

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1433,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:86

    Parameters:

    @@ -1453,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:96

    Parameters:

    @@ -1473,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:104

    Parameters:

    @@ -1493,18 +1493,18 @@ lifecycle events from running.


    render#

    render(): Element‹›

    -

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

    +

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

    Returns: Element‹›


    scrollIntoView#

    scrollIntoView(): void

    -

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

    +

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 fa18657ec9..682567cf5f 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.table/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.table/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -847,13 +847,6 @@ Properties - - -
  • - - Accessors - -
  • @@ -925,8 +918,8 @@
  • - - sortParamsLocal + + sortParams
  • @@ -948,26 +941,6 @@ - - -
  • - - Accessors - - - -
  • @@ -1219,14 +1192,10 @@
  • context
  • props
  • refs
  • -
  • sortParamsLocal
  • +
  • sortParams
  • state
  • contextType
  • -

    Accessors#

    -

    Methods#

    Constructors#

    constructor#

    -

    + new Table(props: Readonly‹TableProps›): Table

    +

    + new Table(props: Readonly‹TableProps› | TableProps): Table

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1270,14 +1239,14 @@ - +
    propsReadonly‹TablePropsReadonly‹TableProps› | TableProps

    Returns: Table

    -

    + new Table(props: TableProps, context?: any): Table

    +

    + new Table(props: TableProps, context: any): Table

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1294,7 +1263,7 @@ TableProps -context? +context any @@ -1304,7 +1273,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1319,12 +1288,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹TableProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

  • [ key: string]: ReactInstance

  • -

    sortParamsLocal#

    -

    sortParamsLocal: object = this.props.sortByDefault

    -

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

    -

    Type declaration:

    +

    sortParams#

    +

    sortParams: Partial‹TableSortParams = Object.assign( + this.props.sortSyncWithUrl ? { + sortBy: sortByUrlParam.get(), + orderBy: orderByUrlParam.get(), + } : {}, + this.props.sortByDefault, + )

    +

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


    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1360,16 +1334,11 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    }

    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

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1418,7 +1387,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1455,7 +1424,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1482,14 +1451,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

    @@ -1520,7 +1489,7 @@ the entire component tree to unmount.

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1533,7 +1502,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹TableProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1567,7 +1536,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1575,7 +1544,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1611,7 +1580,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1620,7 +1589,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1649,7 +1618,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:106

    Parameters:

    @@ -1668,9 +1637,10 @@ lifecycle events from running.

    Returns: any[]


    Protected onSort#

    -

    onSort(params: TableSortParams): void

    -

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

    +

    onSort(__namedParameters: object): void

    +

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

    Parameters:

    +

    __namedParameters: object

    @@ -1680,8 +1650,12 @@ lifecycle events from running.

    - - + + + + + +
    paramsTableSortParamsorderBystring
    sortBystring
    @@ -1690,23 +1664,23 @@ 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:186

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

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

    Returns: object


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1718,7 +1692,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1752,7 +1726,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:129

    Parameters:

    @@ -1772,22 +1746,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:56

    autoSize#

    autoSize: true = true

    -

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

    +

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

    rowLineHeight#

    rowLineHeight: string = "17px"

    -

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

    +

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

    rowPadding#

    rowPadding: string = "8px"

    -

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

    +

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

    scrollable#

    scrollable: true = true

    -

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

    +

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

    sortSyncWithUrl#

    sortSyncWithUrl: true = true

    -

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

    +

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

    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 bb8d8f8eba..e97550454c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1159,9 +1159,9 @@

    Constructors#

    constructor#

    -

    + new TableCell(props: Readonly‹TableCellProps›): TableCell

    +

    + new TableCell(props: Readonly‹TableCellProps› | TableCellProps): TableCell

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1173,14 +1173,14 @@ - +
    propsReadonly‹TableCellPropsReadonly‹TableCellProps› | TableCellProps

    Returns: TableCell

    -

    + new TableCell(props: TableCellProps, context?: any): TableCell

    +

    + new TableCell(props: TableCellProps, context: any): TableCell

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1197,7 +1197,7 @@ TableCellProps -context? +context any @@ -1207,7 +1207,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1222,12 +1222,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹TableCellProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1261,13 +1261,13 @@ 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:37

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1281,7 +1281,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1316,7 +1316,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1353,7 +1353,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1380,14 +1380,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1431,7 +1431,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹TableCellProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1465,7 +1465,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1473,7 +1473,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1509,7 +1509,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1518,7 +1518,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1547,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:27

    Parameters:

    @@ -1568,23 +1568,23 @@ 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:67

    Returns: Element‹›


    renderCheckbox#

    renderCheckbox(): Element‹›

    -

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

    +

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

    Returns: Element‹›


    renderSortIcon#

    renderSortIcon(): Element‹›

    -

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

    +

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

    Returns: Element‹›


    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1596,7 +1596,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 16dff74e2c..405ecb32bd 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1149,9 +1149,9 @@

    Constructors#

    constructor#

    -

    + new TableHead(props: Readonly‹TableHeadProps›): TableHead

    +

    + new TableHead(props: Readonly‹TableHeadProps› | TableHeadProps): TableHead

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1163,14 +1163,14 @@ - +
    propsReadonly‹TableHeadPropsReadonly‹TableHeadProps› | TableHeadProps

    Returns: TableHead

    -

    + new TableHead(props: TableHeadProps, context?: any): TableHead

    +

    + new TableHead(props: TableHeadProps, context: any): TableHead

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1187,7 +1187,7 @@ TableHeadProps -context? +context any @@ -1197,7 +1197,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1212,12 +1212,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹TableHeadProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1252,7 +1252,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1266,7 +1266,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1301,7 +1301,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1338,7 +1338,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1365,14 +1365,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1416,7 +1416,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹TableHeadProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1450,7 +1450,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1458,7 +1458,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1494,7 +1494,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

    @@ -1503,7 +1503,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1533,13 +1533,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1551,7 +1551,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 @@ -1585,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 34280ade50..eb8a10111d 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1104,9 +1104,9 @@

    Constructors#

    constructor#

    -

    + new TableRow(props: Readonly‹TableRowProps›): TableRow

    +

    + new TableRow(props: Readonly‹TableRowProps› | TableRowProps): TableRow

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1118,14 +1118,14 @@ - +
    propsReadonly‹TableRowPropsReadonly‹TableRowProps› | TableRowProps

    Returns: TableRow

    -

    + new TableRow(props: TableRowProps, context?: any): TableRow

    +

    + new TableRow(props: TableRowProps, context: any): TableRow

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1142,7 +1142,7 @@ TableRowProps -context? +context any @@ -1152,7 +1152,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1167,12 +1167,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹TableRowProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1207,7 +1207,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1221,7 +1221,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1293,7 +1293,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1320,14 +1320,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1371,7 +1371,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹TableRowProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1405,7 +1405,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1413,7 +1413,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1449,7 +1449,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1488,13 +1488,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1506,7 +1506,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 c48215880c..abe7cbc831 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1033,12 +1033,12 @@

    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

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1052,7 +1052,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1087,7 +1087,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

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

    @@ -1144,7 +1144,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1171,14 +1171,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1222,7 +1222,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹TabsProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1264,7 +1264,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1300,7 +1300,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1329,13 +1329,13 @@ 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#

    shouldComponentUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): boolean

    Inherited from PageLayout.shouldComponentUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 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 75eb6b6c14..15ea535350 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -598,7 +598,7 @@

  • - Working with mobx + Working with MobX
  • @@ -1223,9 +1223,9 @@

    Constructors#

    constructor#

    -

    + new Tooltip(props: Readonly‹TooltipProps›): Tooltip

    +

    + new Tooltip(props: Readonly‹TooltipProps› | TooltipProps): Tooltip

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1237,14 +1237,14 @@ - +
    propsReadonly‹TooltipPropsReadonly‹TooltipProps› | TooltipProps

    Returns: Tooltip

    -

    + new Tooltip(props: TooltipProps, context?: any): Tooltip

    +

    + new Tooltip(props: TooltipProps, context: any): Tooltip

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1261,7 +1261,7 @@ TooltipProps -context? +context any @@ -1270,12 +1270,12 @@

    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

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1289,21 +1289,21 @@ 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›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1337,22 +1337,22 @@ 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#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1366,7 +1366,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1401,7 +1401,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

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

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

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1485,13 +1485,13 @@ 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#

    componentDidUpdate(prevProps: Readonly‹TooltipProps›, prevState: Readonly‹S›, snapshot?: SS): void

    Inherited from PageLayout.componentDidUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1535,7 +1535,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹TooltipProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1569,13 +1569,13 @@ 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#

    componentWillUpdate(nextProps: Readonly‹TooltipProps›, nextState: Readonly‹S›, nextContext: any): void

    Inherited from PageLayout.componentWillUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1611,7 +1611,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    @@ -1662,7 +1662,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1691,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

    @@ -1738,7 +1738,7 @@ lifecycle events from running.

    setState#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1750,7 +1750,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 diff --git a/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html b/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html new file mode 100644 index 0000000000..1b4188f47a --- /dev/null +++ b/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html @@ -0,0 +1,1827 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Wizard ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    + +
    + + + +
    +
    + + + +

    Class: Wizard ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Wizard

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Wizard(props: Readonly‹WizardProps› | WizardProps): Wizard

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardProps› | WizardProps
    +

    Returns: Wizard

    +

    + new Wizard(props: WizardProps, context: any): Wizard

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardProps
    contextany
    +

    Returns: Wizard

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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‹WizardProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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#

    +

    step#

    +

    get step(): number

    +

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

    +

    Returns: number

    +

    set step(step: number): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    stepnumber
    +

    Returns: void

    +
    +

    steps#

    +

    get steps(): ReactElement‹WizardStepProps‹any›, string | function | object›[]

    +

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

    +

    Returns: ReactElement‹WizardStepProps‹any›, string | function | object›[]

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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‹WizardProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    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‹WizardProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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‹WizardProps
    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:640

    +

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

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹WizardProps›, prevState: Readonly‹State›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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‹WizardProps
    prevStateReadonly‹State›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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‹WizardProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    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‹WizardProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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‹WizardProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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‹WizardProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    firstStep#

    +

    firstStep(): any

    +

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

    +

    Returns: any

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹WizardProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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‹WizardProps
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    Protected getValidStep#

    +

    getValidStep(step: number): number

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    stepnumber
    +

    Returns: number

    +
    +

    isFirstStep#

    +

    isFirstStep(): boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:75

    +

    Returns: boolean

    +
    +

    isLastStep#

    +

    isLastStep(): boolean

    +

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

    +

    Returns: boolean

    +
    +

    lastStep#

    +

    lastStep(): any

    +

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

    +

    Returns: any

    +
    +

    nextStep#

    +

    nextStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:78

    +

    Returns: any

    +
    +

    prevStep#

    +

    prevStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:79

    +

    Returns: any

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof State

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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‹WizardProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    state#

    +

    state: object#

    +

    Overrides PageLayout.state

    +

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

    +

    step#

    +

    step: number = this.getValidStep(this.props.step)

    +

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

    + + + + + + + + +
    +
    + + + + + +
    + + + + + + + + + \ No newline at end of file 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 c605043913..d2c7494b82 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1104,9 +1104,9 @@

    Constructors#

    constructor#

    -

    + new WizardLayout(props: Readonly‹WizardLayoutProps›): WizardLayout

    +

    + new WizardLayout(props: Readonly‹WizardLayoutProps› | WizardLayoutProps): WizardLayout

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    Parameters:

    @@ -1118,14 +1118,14 @@ - +
    propsReadonly‹WizardLayoutPropsReadonly‹WizardLayoutProps› | WizardLayoutProps

    Returns: WizardLayout

    -

    + new WizardLayout(props: WizardLayoutProps, context?: any): WizardLayout

    +

    + new WizardLayout(props: WizardLayoutProps, context: any): WizardLayout

    Inherited from PageLayout.constructor

    -

    Defined in node_modules/@types/react/index.d.ts:488

    +

    Defined in node_modules/@types/react/index.d.ts:475

    deprecated

    see https://reactjs.org/docs/legacy-context.html

    Parameters:

    @@ -1142,7 +1142,7 @@ WizardLayoutProps -context? +context any @@ -1152,7 +1152,7 @@

    context#

    context: any

    Inherited from PageLayout.context

    -

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Defined in node_modules/@types/react/index.d.ts:473

    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.

    @@ -1167,12 +1167,12 @@ Should be used with type annotation or static contextType.

    props#

    props: Readonly‹WizardLayoutProps› & Readonly‹object›

    Inherited from PageLayout.props

    -

    Defined in node_modules/@types/react/index.d.ts:511

    +

    Defined in node_modules/@types/react/index.d.ts:498


    refs#

    refs: object

    Inherited from PageLayout.refs

    -

    Defined in node_modules/@types/react/index.d.ts:517

    +

    Defined in node_modules/@types/react/index.d.ts:504

    deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Type declaration:

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

    state#

    state: Readonly‹S›

    Inherited from PageLayout.state

    -

    Defined in node_modules/@types/react/index.d.ts:512

    +

    Defined in node_modules/@types/react/index.d.ts:499


    Static Optional contextType#

    contextType? : Context‹any›

    Inherited from PageLayout.contextType

    -

    Defined in node_modules/@types/react/index.d.ts:468

    +

    Defined in node_modules/@types/react/index.d.ts:455

    If set, this.context will be set at runtime to the current value of the given Context.

    Usage:

    type MyContext = number
    @@ -1207,7 +1207,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Optional UNSAFE_componentWillMount#

    UNSAFE_componentWillMount(): void

    Inherited from PageLayout.UNSAFE_componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Defined in node_modules/@types/react/index.d.ts:711

    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.

    @@ -1221,7 +1221,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:743

    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.

    @@ -1256,7 +1256,7 @@ prevents this from being invoked.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:771

    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.

    @@ -1293,7 +1293,7 @@ prevents this from being invoked.

    Optional componentDidCatch#

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    Inherited from PageLayout.componentDidCatch

    -

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Defined in node_modules/@types/react/index.d.ts:640

    Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters:

    @@ -1320,14 +1320,14 @@ the entire component tree to unmount.

    Optional componentDidMount#

    componentDidMount(): void

    Inherited from WizardLayout.componentDidMount

    -

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Defined in node_modules/@types/react/index.d.ts:619

    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

    +

    Defined in node_modules/@types/react/index.d.ts:682

    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:

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

    Optional componentWillMount#

    componentWillMount(): void

    Inherited from PageLayout.componentWillMount

    -

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Defined in node_modules/@types/react/index.d.ts:697

    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 @@ -1371,7 +1371,7 @@ prevents this from being invoked.

    Optional componentWillReceiveProps#

    componentWillReceiveProps(nextProps: Readonly‹WizardLayoutProps›, nextContext: any): void

    Inherited from PageLayout.componentWillReceiveProps

    -

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Defined in node_modules/@types/react/index.d.ts:726

    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.

    @@ -1405,7 +1405,7 @@ prevents this from being invoked.

    Optional componentWillUnmount#

    componentWillUnmount(): void

    Inherited from WizardLayout.componentWillUnmount

    -

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Defined in node_modules/@types/react/index.d.ts:635

    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

    @@ -1413,7 +1413,7 @@ cancelled network requests, or cleaning up any DOM elements created in com

    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

    +

    Defined in node_modules/@types/react/index.d.ts:756

    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 @@ -1449,7 +1449,7 @@ prevents this from being invoked.

    forceUpdate#

    forceUpdate(callback?: function): void

    Inherited from PageLayout.forceUpdate

    -

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Defined in node_modules/@types/react/index.d.ts:490

    Parameters:

    Optional callback: function

    ▸ (): void

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

    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

    +

    Defined in node_modules/@types/react/index.d.ts:676

    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.

    @@ -1488,13 +1488,13 @@ 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#

    setStateK›(state: function | S | object, callback?: function): void

    Inherited from PageLayout.setState

    -

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Defined in node_modules/@types/react/index.d.ts:485

    Type parameters:

    K: keyof S

    Parameters:

    @@ -1506,7 +1506,7 @@ lifecycle events from running.

    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

    +

    Defined in node_modules/@types/react/index.d.ts:630

    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 diff --git a/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html b/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html new file mode 100644 index 0000000000..81f6262c73 --- /dev/null +++ b/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html @@ -0,0 +1,1716 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WizardStep ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: WizardStep ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    WizardStep

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new WizardStep(props: Readonly‹WizardStepProps› | WizardStepProps): WizardStep

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardStepProps› | WizardStepProps
    +

    Returns: WizardStep

    +

    + new WizardStep(props: WizardStepProps, context: any): WizardStep

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardStepProps
    contextany
    +

    Returns: WizardStep

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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‹WizardStepProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: WizardStepState

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/wizard/wizard.tsx:136

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

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

    +

    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‹WizardStepProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    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‹WizardStepProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

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

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹WizardStepProps›, prevState: Readonly‹WizardStepState›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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‹WizardStepProps
    prevStateReadonly‹WizardStepState›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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‹WizardStepProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    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‹WizardStepProps
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/wizard/wizard.tsx:143

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹WizardStepProps›, prevState: Readonly‹WizardStepState›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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‹WizardStepProps
    prevStateReadonly‹WizardStepState›
    +

    Returns: SS | null

    +
    +

    next#

    +

    next(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:154

    +

    Returns: void

    +
    +

    prev#

    +

    prev(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:147

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:194

    +

    Returns: Element‹›

    +
    +

    renderLoading#

    +

    renderLoading(): Element‹›

    +

    Defined in src/renderer/components/wizard/wizard.tsx:186

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof WizardStepState

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: boolean

    +
    +

    submit#

    +

    submit(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:177

    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/wizard/wizard.tsx:139

    +

    scrollable#

    +

    scrollable: true = true

    +

    Defined in src/renderer/components/wizard/wizard.tsx:140

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file 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 1df2da0ba6..515442cade 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1191,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:93

    Parameters:

    @@ -1212,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:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:101


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


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

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

    Parameters:

    @@ -1279,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:126

    Parameters:

    @@ -1312,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:147

    Parameters:

    @@ -1335,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:139

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

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

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

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

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

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

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1418,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:73

    Parameters:

    @@ -1439,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:81

    Parameters:

    @@ -1460,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:85

    Parameters:

    @@ -1481,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:77

    Parameters:

    @@ -1502,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:89

    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 9bcbfba22a..5e4f457893 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1207,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:93

    Parameters:

    @@ -1228,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:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:101


    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:

    @@ -1312,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:126

    Parameters:

    @@ -1345,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:147

    Parameters:

    @@ -1368,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:139

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

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

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

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

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

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

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1457,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:73

    Parameters:

    @@ -1478,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:81

    Parameters:

    @@ -1499,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:85

    Parameters:

    @@ -1520,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:77

    Parameters:

    @@ -1541,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:89

    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 45fd412448..319afdc344 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1193,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:

    @@ -1214,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:99


    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:

    @@ -1283,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:126

    Parameters:

    @@ -1316,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:147

    Parameters:

    @@ -1339,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:139

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

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

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

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

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

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

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1421,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:73

    Parameters:

    @@ -1442,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:81

    Parameters:

    @@ -1463,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:85

    Parameters:

    @@ -1484,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:77

    Parameters:

    @@ -1505,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:89

    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 a37edfeee9..dadddf793e 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -901,6 +901,13 @@ bufferSize + + +
  • + + contextReady + +
  • @@ -943,6 +950,13 @@ selectedItemsIds +
  • + +
  • + + Static defaultContext + +
  • @@ -958,6 +972,20 @@
    @@ -1382,12 +1492,12 @@
    -

    Returns: IReactionDisposer

    +

    Returns: void


    create#

    create(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:143

    +

    Defined in src/renderer/kube-object.store.ts:230

    Parameters:

    params: object

    @@ -1415,7 +1525,7 @@

    createItem(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:139

    +

    Defined in src/renderer/kube-object.store.ts:226

    Parameters:

    params: object

    @@ -1442,7 +1552,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:

    @@ -1463,7 +1573,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:130

    Parameters:

    @@ -1484,7 +1594,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:63

    Parameters:

    @@ -1509,10 +1619,31 @@

    Returns: ConfigMap[]


    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +

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

    Parameters:

    @@ -1534,7 +1665,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:77

    Parameters:

    @@ -1559,7 +1690,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:85

    Parameters:

    @@ -1577,10 +1708,37 @@

    Returns: ConfigMap


    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ConfigMap[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ConfigMap[]

    +

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

    Parameters:

    @@ -1598,10 +1756,23 @@

    Returns: Record‹string, number›


    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +

    isSelected#

    isSelected(item: ConfigMap): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1622,7 +1793,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:159

    Parameters:

    @@ -1645,7 +1816,7 @@

    load#

    load(params: object): Promise‹ConfigMap

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:118

    +

    Defined in src/renderer/kube-object.store.ts:205

    Parameters:

    params: object

    @@ -1669,16 +1840,36 @@

    Returns: Promise‹ConfigMap


    loadAll#

    -

    loadAll(): Promise‹void›

    +

    loadAll(options: object): Promise‹void | ConfigMap[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    -

    Returns: Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    +
    + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ConfigMap[]›


    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:133

    +

    Defined in src/renderer/kube-object.store.ts:220

    Parameters:

    @@ -1700,7 +1891,7 @@

    loadItem(params: object): Promise‹ConfigMap

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:200

    Parameters:

    params: object

    @@ -1724,11 +1915,12 @@

    Returns: Promise‹ConfigMap


    Protected loadItems#

    -

    loadItems(allowedNamespaces?: string[]): Promise‹ConfigMap[]›

    +

    loadItems(__namedParameters: object): 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:106

    Parameters:

    +

    __namedParameters: object

    @@ -1738,18 +1930,63 @@ - + + + + +
    allowedNamespaces?apiKubeApi‹any›
    namespaces string[]

    Returns: Promise‹ConfigMap[]›


    -

    Protected onWatchApiEvent#

    -

    onWatchApiEvent(evt: IKubeWatchEvent): void

    -

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:184

    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ConfigMap[], __namedParameters: object): ConfigMap[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    Parameters:

    +

    partialItems: ConfigMap[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ConfigMap[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    @@ -1759,17 +1996,25 @@ - - + + + + + + + + + +
    evtIKubeWatchEventforce?boolean
    merge?boolean
    namespaces?string[]
    -

    Returns: void

    +

    Returns: Promise‹void | T[]›


    remove#

    remove(item: ConfigMap): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:161

    +

    Defined in src/renderer/kube-object.store.ts:248

    Parameters:

    @@ -1790,7 +2035,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:119

    Parameters:

    item: ConfigMap

    request: function

    @@ -1801,25 +2046,46 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:254

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

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    errorany

    Returns: void


    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:166

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

    Parameters:

    @@ -1840,7 +2106,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:43

    Parameters:

    @@ -1871,10 +2137,10 @@

    Returns: ConfigMap[]


    subscribe#

    -

    subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:180

    +

    Defined in src/renderer/kube-object.store.ts:271

    Parameters:

    @@ -1887,8 +2153,8 @@ - - + +
    apisKubeApi‹T›[][this.api]KubeApi‹any›[]this.getSubscribeApis()
    @@ -1897,7 +2163,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:140

    Parameters:

    @@ -1918,7 +2184,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:149

    Parameters:

    @@ -1941,7 +2207,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:135

    Parameters:

    @@ -1962,7 +2228,7 @@

    update#

    update(item: ConfigMap, data: Partial‹ConfigMap›): Promise‹ConfigMap

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:152

    +

    Defined in src/renderer/kube-object.store.ts:239

    Parameters:

    @@ -1987,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:190

    +

    Defined in src/renderer/kube-object.store.ts:349

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

    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 606d601de4..5163ee54da 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -908,6 +908,13 @@ bufferSize + + +
  • + + contextReady + +
  • @@ -950,6 +957,13 @@ selectedItemsIds +
  • + +
  • + + Static defaultContext + +
  • @@ -965,6 +979,20 @@
    @@ -1330,65 +1418,87 @@

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

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    -

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:172

    +

    Defined in src/renderer/kube-object.store.ts:259


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


    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

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): T[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: T[]

    +

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

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

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    -

    bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:174

    +

    Defined in src/renderer/kube-object.store.ts:261

    Parameters:

    @@ -1406,12 +1516,12 @@
    -

    Returns: IReactionDisposer

    +

    Returns: void


    create#

    create(params: object, data?: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:143

    +

    Defined in src/renderer/kube-object.store.ts:230

    Parameters:

    params: object

    @@ -1439,7 +1549,7 @@

    createItem(params: object, data?: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:139

    +

    Defined in src/renderer/kube-object.store.ts:226

    Parameters:

    params: object

    @@ -1466,7 +1576,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:

    @@ -1487,7 +1597,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:130

    Parameters:

    @@ -1508,7 +1618,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:63

    Parameters:

    @@ -1533,10 +1643,31 @@

    Returns: T[]


    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +

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

    Parameters:

    @@ -1558,7 +1689,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:77

    Parameters:

    @@ -1583,7 +1714,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:85

    Parameters:

    @@ -1601,10 +1732,37 @@

    Returns: T


    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): T[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: T[]

    +

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

    Parameters:

    @@ -1622,10 +1780,23 @@

    Returns: Record‹string, number›


    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +

    isSelected#

    isSelected(item: T): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1646,7 +1817,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:159

    Parameters:

    @@ -1669,7 +1840,7 @@

    load#

    load(params: object): Promise‹T›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:118

    +

    Defined in src/renderer/kube-object.store.ts:205

    Parameters:

    params: object

    @@ -1693,16 +1864,36 @@

    Returns: Promise‹T›


    loadAll#

    -

    loadAll(): Promise‹void›

    +

    loadAll(options: object): Promise‹void | T[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    -

    Returns: Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    +
    + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›


    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:133

    +

    Defined in src/renderer/kube-object.store.ts:220

    Parameters:

    @@ -1724,7 +1915,7 @@

    loadItem(params: object): Promise‹T›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:200

    Parameters:

    params: object

    @@ -1748,11 +1939,12 @@

    Returns: Promise‹T›


    Protected loadItems#

    -

    loadItems(allowedNamespaces?: string[]): Promise‹T[]›

    +

    loadItems(__namedParameters: object): 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:106

    Parameters:

    +

    __namedParameters: object

    @@ -1762,18 +1954,63 @@ - + + + + +
    allowedNamespaces?apiKubeApi‹any›
    namespaces string[]

    Returns: Promise‹T[]›


    -

    Protected onWatchApiEvent#

    -

    onWatchApiEvent(evt: IKubeWatchEvent): void

    -

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:184

    +

    Protected mergeItems#

    +

    mergeItems(partialItems: T[], __namedParameters: object): T[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    Parameters:

    +

    partialItems: T[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: T[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    @@ -1783,17 +2020,25 @@ - - + + + + + + + + + +
    evtIKubeWatchEventforce?boolean
    merge?boolean
    namespaces?string[]
    -

    Returns: void

    +

    Returns: Promise‹void | T[]›


    remove#

    remove(item: T): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:161

    +

    Defined in src/renderer/kube-object.store.ts:248

    Parameters:

    @@ -1814,7 +2059,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:119

    Parameters:

    item: T

    request: function

    @@ -1825,25 +2070,46 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:254

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

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    errorany

    Returns: void


    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:166

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

    Parameters:

    @@ -1864,7 +2130,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:43

    Parameters:

    @@ -1895,10 +2161,10 @@

    Returns: T[]


    subscribe#

    -

    subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:180

    +

    Defined in src/renderer/kube-object.store.ts:271

    Parameters:

    @@ -1911,8 +2177,8 @@ - - + +
    apisKubeApi‹T›[][this.api]KubeApi‹any›[]this.getSubscribeApis()
    @@ -1921,7 +2187,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:140

    Parameters:

    @@ -1942,7 +2208,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:149

    Parameters:

    @@ -1965,7 +2231,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:135

    Parameters:

    @@ -1986,7 +2252,7 @@

    update#

    update(item: T, data: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:152

    +

    Defined in src/renderer/kube-object.store.ts:239

    Parameters:

    @@ -2011,13 +2277,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:190

    +

    Defined in src/renderer/kube-object.store.ts:349

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

    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 086eed70c0..5db30ce7e1 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -901,6 +901,13 @@ bufferSize + + +
  • + + contextReady + +
  • @@ -943,6 +950,13 @@ selectedItemsIds +
  • + +
  • + + Static defaultContext + +
  • @@ -958,6 +972,20 @@
    @@ -1411,12 +1521,12 @@
    -

    Returns: IReactionDisposer

    +

    Returns: void


    create#

    create(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:143

    +

    Defined in src/renderer/kube-object.store.ts:230

    Parameters:

    params: object

    @@ -1444,7 +1554,7 @@

    createItem(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:139

    +

    Defined in src/renderer/kube-object.store.ts:226

    Parameters:

    params: object

    @@ -1471,7 +1581,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:

    @@ -1492,7 +1602,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:130

    Parameters:

    @@ -1513,7 +1623,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:63

    Parameters:

    @@ -1540,7 +1650,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:

    @@ -1562,10 +1672,31 @@

    Returns: CustomResourceDefinition‹›


    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +

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

    Parameters:

    @@ -1587,7 +1718,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:77

    Parameters:

    @@ -1611,7 +1742,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:

    @@ -1632,7 +1763,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:85

    Parameters:

    @@ -1650,10 +1781,37 @@

    Returns: CustomResourceDefinition


    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: CustomResourceDefinition[]

    +

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

    Parameters:

    @@ -1671,10 +1829,23 @@

    Returns: Record‹string, number›


    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +

    isSelected#

    isSelected(item: CustomResourceDefinition): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1695,7 +1866,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:159

    Parameters:

    @@ -1718,7 +1889,7 @@

    load#

    load(params: object): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:118

    +

    Defined in src/renderer/kube-object.store.ts:205

    Parameters:

    params: object

    @@ -1742,16 +1913,36 @@

    Returns: Promise‹CustomResourceDefinition


    loadAll#

    -

    loadAll(): Promise‹void›

    +

    loadAll(options: object): Promise‹void | CustomResourceDefinition[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    -

    Returns: Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    +
    + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | CustomResourceDefinition[]›


    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:133

    +

    Defined in src/renderer/kube-object.store.ts:220

    Parameters:

    @@ -1773,7 +1964,7 @@

    loadItem(params: object): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:200

    Parameters:

    params: object

    @@ -1797,11 +1988,12 @@

    Returns: Promise‹CustomResourceDefinition


    Protected loadItems#

    -

    loadItems(allowedNamespaces?: string[]): Promise‹CustomResourceDefinition[]›

    +

    loadItems(__namedParameters: object): 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:106

    Parameters:

    +

    __namedParameters: object

    @@ -1811,18 +2003,63 @@ - + + + + +
    allowedNamespaces?apiKubeApi‹any›
    namespaces string[]

    Returns: Promise‹CustomResourceDefinition[]›


    -

    Protected onWatchApiEvent#

    -

    onWatchApiEvent(evt: IKubeWatchEvent): void

    -

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:184

    +

    Protected mergeItems#

    +

    mergeItems(partialItems: CustomResourceDefinition[], __namedParameters: object): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    Parameters:

    +

    partialItems: CustomResourceDefinition[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: CustomResourceDefinition[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    @@ -1832,17 +2069,25 @@ - - + + + + + + + + + +
    evtIKubeWatchEventforce?boolean
    merge?boolean
    namespaces?string[]
    -

    Returns: void

    +

    Returns: Promise‹void | T[]›


    remove#

    remove(item: CustomResourceDefinition): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:161

    +

    Defined in src/renderer/kube-object.store.ts:248

    Parameters:

    @@ -1863,7 +2108,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:119

    Parameters:

    item: CustomResourceDefinition

    request: function

    @@ -1874,25 +2119,46 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:254

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

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    errorany

    Returns: void


    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:166

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

    Parameters:

    @@ -1913,7 +2179,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:

    @@ -1932,10 +2198,10 @@

    Returns: CustomResourceDefinition‹›[]


    subscribe#

    -

    subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:180

    +

    Defined in src/renderer/kube-object.store.ts:271

    Parameters:

    @@ -1948,8 +2214,8 @@ - - + +
    apisKubeApi‹T›[][this.api]KubeApi‹any›[]this.getSubscribeApis()
    @@ -1958,7 +2224,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:140

    Parameters:

    @@ -1979,7 +2245,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:149

    Parameters:

    @@ -2002,7 +2268,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:135

    Parameters:

    @@ -2023,7 +2289,7 @@

    update#

    update(item: CustomResourceDefinition, data: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:152

    +

    Defined in src/renderer/kube-object.store.ts:239

    Parameters:

    @@ -2048,13 +2314,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:190

    +

    Defined in src/renderer/kube-object.store.ts:349

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

    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 94241df58c..a96b2423b3 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1088,6 +1088,13 @@ isNeverRun + + +
  • + + isSuspend + +
  • @@ -1205,6 +1212,7 @@
  • getSearchFields
  • getSuspendFlag
  • isNeverRun
  • +
  • isSuspend
  • toPlainObject
  • update
  • create
  • @@ -1217,7 +1225,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:93

    Parameters:

    @@ -1238,17 +1246,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:47


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


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

    Type declaration:

    @@ -1406,7 +1414,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:126

    Parameters:

    @@ -1439,7 +1447,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:147

    Parameters:

    @@ -1462,81 +1470,86 @@

    getFinalizers#

    getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:139

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

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

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

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

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

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

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

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

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

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

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

    +

    Returns: boolean

    +
    +

    isSuspend#

    +

    isSuspend(): boolean

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:126

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1559,7 +1572,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:73

    Parameters:

    @@ -1580,7 +1593,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:81

    Parameters:

    @@ -1601,7 +1614,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:85

    Parameters:

    @@ -1622,7 +1635,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:77

    Parameters:

    @@ -1643,7 +1656,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:89

    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 8459cb7260..82f36edc8b 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -901,6 +901,13 @@ bufferSize + + +
  • + + contextReady + +
  • @@ -943,6 +950,13 @@ selectedItemsIds +
  • + +
  • + + Static defaultContext + +
  • @@ -958,6 +972,20 @@
    @@ -1390,12 +1500,12 @@
    -

    Returns: IReactionDisposer

    +

    Returns: void


    create#

    create(params: object, data?: Partial‹CronJob›): Promise‹CronJob

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:143

    +

    Defined in src/renderer/kube-object.store.ts:230

    Parameters:

    params: object

    @@ -1423,7 +1533,7 @@

    createItem(params: object, data?: Partial‹CronJob›): Promise‹CronJob

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:139

    +

    Defined in src/renderer/kube-object.store.ts:226

    Parameters:

    params: object

    @@ -1450,7 +1560,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:

    @@ -1471,7 +1581,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:130

    Parameters:

    @@ -1491,7 +1601,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:

    @@ -1512,7 +1622,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:63

    Parameters:

    @@ -1537,10 +1647,31 @@

    Returns: CronJob[]


    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +

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

    Parameters:

    @@ -1562,7 +1693,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:77

    Parameters:

    @@ -1587,7 +1718,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:85

    Parameters:

    @@ -1605,10 +1736,37 @@

    Returns: CronJob


    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): CronJob[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: CronJob[]

    +

    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:

    @@ -1634,10 +1792,23 @@
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +

    isSelected#

    isSelected(item: CronJob): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1658,7 +1829,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:159

    Parameters:

    @@ -1681,7 +1852,7 @@

    load#

    load(params: object): Promise‹CronJob

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:118

    +

    Defined in src/renderer/kube-object.store.ts:205

    Parameters:

    params: object

    @@ -1705,16 +1876,36 @@

    Returns: Promise‹CronJob


    loadAll#

    -

    loadAll(): Promise‹void›

    +

    loadAll(options: object): Promise‹void | CronJob[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    -

    Returns: Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    +
    + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | CronJob[]›


    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:133

    +

    Defined in src/renderer/kube-object.store.ts:220

    Parameters:

    @@ -1736,7 +1927,7 @@

    loadItem(params: object): Promise‹CronJob

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:200

    Parameters:

    params: object

    @@ -1760,11 +1951,12 @@

    Returns: Promise‹CronJob


    Protected loadItems#

    -

    loadItems(allowedNamespaces?: string[]): Promise‹CronJob[]›

    +

    loadItems(__namedParameters: object): 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:106

    Parameters:

    +

    __namedParameters: object

    @@ -1774,18 +1966,63 @@ - + + + + +
    allowedNamespaces?apiKubeApi‹any›
    namespaces string[]

    Returns: Promise‹CronJob[]›


    -

    Protected onWatchApiEvent#

    -

    onWatchApiEvent(evt: IKubeWatchEvent): void

    -

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:184

    +

    Protected mergeItems#

    +

    mergeItems(partialItems: CronJob[], __namedParameters: object): CronJob[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    Parameters:

    +

    partialItems: CronJob[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: CronJob[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    @@ -1795,17 +2032,25 @@ - - + + + + + + + + + +
    evtIKubeWatchEventforce?boolean
    merge?boolean
    namespaces?string[]
    -

    Returns: void

    +

    Returns: Promise‹void | T[]›


    remove#

    remove(item: CronJob): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:161

    +

    Defined in src/renderer/kube-object.store.ts:248

    Parameters:

    @@ -1826,7 +2071,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:119

    Parameters:

    item: CronJob

    request: function

    @@ -1837,25 +2082,46 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:254

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

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    errorany

    Returns: void


    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:166

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

    Parameters:

    @@ -1876,7 +2142,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:43

    Parameters:

    @@ -1907,10 +2173,10 @@

    Returns: CronJob[]


    subscribe#

    -

    subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:180

    +

    Defined in src/renderer/kube-object.store.ts:271

    Parameters:

    @@ -1923,8 +2189,8 @@ - - + +
    apisKubeApi‹T›[][this.api]KubeApi‹any›[]this.getSubscribeApis()
    @@ -1933,7 +2199,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:140

    Parameters:

    @@ -1954,7 +2220,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:149

    Parameters:

    @@ -1977,7 +2243,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:135

    Parameters:

    @@ -1998,7 +2264,7 @@

    update#

    update(item: CronJob, data: Partial‹CronJob›): Promise‹CronJob

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:152

    +

    Defined in src/renderer/kube-object.store.ts:239

    Parameters:

    @@ -2023,13 +2289,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:190

    +

    Defined in src/renderer/kube-object.store.ts:349

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

    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 d653e710cb..5065881c26 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1305,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:93

    Parameters:

    @@ -1326,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:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:101


    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:

    @@ -1463,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:126

    Parameters:

    @@ -1496,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:147

    Parameters:

    @@ -1518,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:139

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

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

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

    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

    @@ -1615,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:112

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1702,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:73

    Parameters:

    @@ -1723,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:81

    Parameters:

    @@ -1744,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:85

    Parameters:

    @@ -1765,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:77

    Parameters:

    @@ -1786,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:89

    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 dafa0fe401..e60621ed8f 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1241,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:93

    Parameters:

    @@ -1262,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:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:101


    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:

    @@ -1434,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:126

    Parameters:

    @@ -1479,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:147

    Parameters:

    @@ -1502,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:139

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

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

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

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

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

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

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1608,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:73

    Parameters:

    @@ -1629,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:81

    Parameters:

    @@ -1650,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:85

    Parameters:

    @@ -1671,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:77

    Parameters:

    @@ -1692,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:89

    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 ca8ea925db..c034ed719b 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -901,6 +901,13 @@ bufferSize + + +
  • + + contextReady + +
  • @@ -950,6 +957,13 @@ selectedItemsIds +
  • + +
  • + + Static defaultContext + +
  • @@ -965,6 +979,20 @@
    @@ -1410,12 +1520,12 @@
    -

    Returns: IReactionDisposer

    +

    Returns: void


    create#

    create(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:143

    +

    Defined in src/renderer/kube-object.store.ts:230

    Parameters:

    params: object

    @@ -1443,7 +1553,7 @@

    createItem(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:139

    +

    Defined in src/renderer/kube-object.store.ts:226

    Parameters:

    params: object

    @@ -1470,7 +1580,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:

    @@ -1491,7 +1601,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:130

    Parameters:

    @@ -1512,7 +1622,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:63

    Parameters:

    @@ -1537,10 +1647,31 @@

    Returns: DaemonSet[]


    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +

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

    Parameters:

    @@ -1562,7 +1693,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:77

    Parameters:

    @@ -1587,7 +1718,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:85

    Parameters:

    @@ -1607,7 +1738,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:

    @@ -1625,10 +1756,37 @@

    Returns: Pod[]


    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): DaemonSet[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: DaemonSet[]

    +

    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:

    @@ -1657,10 +1815,23 @@
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +

    isSelected#

    isSelected(item: DaemonSet): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1681,7 +1852,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:159

    Parameters:

    @@ -1704,7 +1875,7 @@

    load#

    load(params: object): Promise‹DaemonSet

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:118

    +

    Defined in src/renderer/kube-object.store.ts:205

    Parameters:

    params: object

    @@ -1728,16 +1899,36 @@

    Returns: Promise‹DaemonSet


    loadAll#

    -

    loadAll(): Promise‹void›

    +

    loadAll(options: object): Promise‹void | DaemonSet[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    -

    Returns: Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    +
    + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | DaemonSet[]›


    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:133

    +

    Defined in src/renderer/kube-object.store.ts:220

    Parameters:

    @@ -1759,7 +1950,7 @@

    loadItem(params: object): Promise‹DaemonSet

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:200

    Parameters:

    params: object

    @@ -1783,11 +1974,12 @@

    Returns: Promise‹DaemonSet


    Protected loadItems#

    -

    loadItems(allowedNamespaces?: string[]): Promise‹DaemonSet[]›

    +

    loadItems(__namedParameters: object): 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:106

    Parameters:

    +

    __namedParameters: object

    @@ -1797,7 +1989,11 @@ - + + + + + @@ -1806,7 +2002,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:

    allowedNamespaces?apiKubeApi‹any›
    namespaces string[]
    @@ -1824,11 +2020,52 @@

    Returns: Promise‹void›


    -

    Protected onWatchApiEvent#

    -

    onWatchApiEvent(evt: IKubeWatchEvent): void

    -

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:184

    +

    Protected mergeItems#

    +

    mergeItems(partialItems: DaemonSet[], __namedParameters: object): DaemonSet[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    Parameters:

    +

    partialItems: DaemonSet[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: DaemonSet[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    @@ -1838,17 +2075,25 @@ - - + + + + + + + + + +
    evtIKubeWatchEventforce?boolean
    merge?boolean
    namespaces?string[]
    -

    Returns: void

    +

    Returns: Promise‹void | T[]›


    remove#

    remove(item: DaemonSet): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:161

    +

    Defined in src/renderer/kube-object.store.ts:248

    Parameters:

    @@ -1869,7 +2114,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:119

    Parameters:

    item: DaemonSet

    request: function

    @@ -1880,25 +2125,46 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:254

    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

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    errorany

    Returns: void


    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:166

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

    Parameters:

    @@ -1919,7 +2185,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:43

    Parameters:

    @@ -1950,10 +2216,10 @@

    Returns: DaemonSet[]


    subscribe#

    -

    subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:180

    +

    Defined in src/renderer/kube-object.store.ts:271

    Parameters:

    @@ -1966,8 +2232,8 @@ - - + +
    apisKubeApi‹T›[][this.api]KubeApi‹any›[]this.getSubscribeApis()
    @@ -1976,7 +2242,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:140

    Parameters:

    @@ -1997,7 +2263,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:149

    Parameters:

    @@ -2020,7 +2286,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:135

    Parameters:

    @@ -2041,7 +2307,7 @@

    update#

    update(item: DaemonSet, data: Partial‹DaemonSet›): Promise‹DaemonSet

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:152

    +

    Defined in src/renderer/kube-object.store.ts:239

    Parameters:

    @@ -2066,13 +2332,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:190

    +

    Defined in src/renderer/kube-object.store.ts:349

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

    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 cb90c5f493..68166faed3 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1257,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:93

    Parameters:

    @@ -1278,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:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:101


    spec#

    spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:55

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:75

    Type declaration:

    @@ -1455,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:126

    Parameters:

    @@ -1500,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:147

    Parameters:

    @@ -1522,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:171

    Parameters:

    @@ -1544,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:183

    Parameters:

    @@ -1567,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:139

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

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

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

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

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

    Returns: object[]


    getReplicas#

    getReplicas(): number

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:188

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:187

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

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1673,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:73

    Parameters:

    @@ -1694,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:81

    Parameters:

    @@ -1715,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:85

    Parameters:

    @@ -1736,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:77

    Parameters:

    @@ -1757,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:89

    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 34b63868fd..ed47a76916 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -974,8 +974,8 @@
  • - - Static parseApi + + Protected watchDisposer
  • @@ -1081,6 +1081,13 @@ list + + +
  • + + Protected modifyWatchEvent + +
  • @@ -1137,13 +1144,6 @@ watch -
  • - -
  • - - Static watchAll - -
  • @@ -1190,7 +1190,7 @@
  • options
  • request
  • resourceVersions
  • -
  • parseApi
  • +
  • watchDisposer
  • Accessors#

    Constructors#

    constructor#

    + new DeploymentApi(options: IKubeApiOptions‹Deployment›): DeploymentApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:117

    Parameters:

    @@ -1243,84 +1243,86 @@

    apiBase#

    apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:104

    +

    Defined in src/renderer/api/kube-api.ts:106


    apiGroup#

    apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:106

    +

    Defined in src/renderer/api/kube-api.ts:108


    apiPrefix#

    apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:105

    +

    Defined in src/renderer/api/kube-api.ts:107


    apiResource#

    apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:109

    +

    Defined in src/renderer/api/kube-api.ts:111


    apiVersion#

    apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:107

    +

    Defined in src/renderer/api/kube-api.ts:109


    Optional apiVersionPreferred#

    apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:108

    +

    Defined in src/renderer/api/kube-api.ts:110


    isNamespaced#

    isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:110

    +

    Defined in src/renderer/api/kube-api.ts:112


    kind#

    kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:103

    +

    Defined in src/renderer/api/kube-api.ts:105


    objectConstructor#

    objectConstructor: IKubeObjectConstructor‹Deployment

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:112

    +

    Defined in src/renderer/api/kube-api.ts:114


    Protected options#

    options: IKubeApiOptions‹Deployment

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:116

    +

    Defined in src/renderer/api/kube-api.ts:119


    Protected request#

    request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:113

    +

    Defined in src/renderer/api/kube-api.ts:115


    Protected resourceVersions#

    resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:116


    -

    Static parseApi#

    -

    parseApi: parseKubeApi = parseKubeApi

    -

    Inherited from KubeApi.parseApi

    -

    Defined in src/renderer/api/kube-api.ts:95

    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:

    +

    ▸ (): void

    Accessors#

    apiVersionWithGroup#

    get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:144

    +

    Defined in src/renderer/api/kube-api.ts:147

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:206

    +

    Defined in src/renderer/api/kube-api.ts:209

    Returns: Promise‹void›


    create#

    create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:326

    +

    Defined in src/renderer/api/kube-api.ts:329

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1350,7 +1352,7 @@

    delete#

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:353

    +

    Defined in src/renderer/api/kube-api.ts:356

    Parameters:

    __namedParameters: object

    @@ -1379,7 +1381,7 @@

    get#

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:318

    +

    Defined in src/renderer/api/kube-api.ts:321

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1408,7 +1410,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

    @@ -1434,7 +1436,7 @@

    getResourceVersion#

    getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:239

    +

    Defined in src/renderer/api/kube-api.ts:242

    Parameters:

    @@ -1456,7 +1458,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

    @@ -1482,7 +1484,7 @@

    getUrl#

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:247

    +

    Defined in src/renderer/api/kube-api.ts:250

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1512,7 +1514,7 @@

    getWatchUrl#

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:360

    +

    Defined in src/renderer/api/kube-api.ts:363

    Parameters:

    @@ -1540,7 +1542,7 @@

    list#

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:310

    +

    Defined in src/renderer/api/kube-api.ts:313

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1562,10 +1564,31 @@

    Optional query: IKubeApiQueryParams

    Returns: Promise‹Deployment[]›


    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:446

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +

    Protected normalizeQuery#

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:259

    +

    Defined in src/renderer/api/kube-api.ts:262

    Parameters:

    @@ -1588,7 +1611,7 @@

    Protected parseResponse#

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:271

    +

    Defined in src/renderer/api/kube-api.ts:274

    Parameters:

    @@ -1613,7 +1636,7 @@

    refreshResourceVersion#

    refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:243

    +

    Defined in src/renderer/api/kube-api.ts:246

    Parameters:

    Optional params: object

    @@ -1634,7 +1657,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

    @@ -1659,7 +1682,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

    @@ -1686,7 +1709,7 @@

    setResourceVersion#

    setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:235

    +

    Defined in src/renderer/api/kube-api.ts:238

    Parameters:

    @@ -1714,7 +1737,7 @@

    update#

    update(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:344

    +

    Defined in src/renderer/api/kube-api.ts:347

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1742,32 +1765,28 @@

    Returns: Promise‹Deployment


    watch#

    -

    watch(): function

    +

    watch(opts: KubeApiWatchOptions): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:368

    -

    Returns: function

    -

    ▸ (): void

    -
    -

    Static watchAll#

    -

    watchAll(...apis: KubeApi[]): (Anonymous function)

    -

    Inherited from KubeApi.watchAll

    -

    Defined in src/renderer/api/kube-api.ts:97

    +

    Defined in src/renderer/api/kube-api.ts:371

    Parameters:

    + - - + + +
    Name TypeDefault
    ...apisKubeApi[]optsKubeApiWatchOptions{ namespace: "" }
    -

    Returns: (Anonymous function)

    +

    Returns: function

    +

    ▸ (): void

    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 628dfb7707..d607039073 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -901,6 +901,13 @@ bufferSize + + +
  • + + contextReady + +
  • @@ -950,6 +957,13 @@ selectedItemsIds +
  • + +
  • + + Static defaultContext + +
  • @@ -965,6 +979,20 @@
    +
    + + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html new file mode 100644 index 0000000000..be889b171f --- /dev/null +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LimitRangesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LimitRangesStore#

    +

    Hierarchy#

    +

    KubeObjectStoreLimitRange

    +

    LimitRangesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LimitRangesStore(): LimitRangesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: LimitRangesStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiLimitRange‹›› = limitRangeApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-limit-ranges/limit-ranges.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

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

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: LimitRange[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: LimitRange[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹LimitRange

    +

    Returns: Promise‹LimitRange

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:226

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹LimitRange

    +

    Returns: Promise‹LimitRange

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: LimitRange): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: LimitRange[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsLimitRange[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): LimitRange[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: LimitRange[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): LimitRange[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: LimitRange[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): LimitRange

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: LimitRange

    +
    +

    getByPath#

    +

    getByPath(path: string): LimitRange

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: LimitRange

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: LimitRange[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: LimitRange[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsLimitRange[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: LimitRange): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: LimitRange[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsLimitRange[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹LimitRange

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | LimitRange[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | LimitRange[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹LimitRange

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹LimitRange[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹LimitRange[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: LimitRange[], __namedParameters: object): LimitRange[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: LimitRange[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: LimitRange[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: LimitRange): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: LimitRange, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: LimitRange

    +

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

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: LimitRange): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: LimitRange[], sorting?: function[], order?: "asc" | "desc"): LimitRange[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsLimitRange[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: LimitRange[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: LimitRange): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: LimitRange[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsLimitRange[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: LimitRange): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    update#

    +

    update(item: LimitRange, data: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    dataPartial‹LimitRange
    +

    Returns: Promise‹LimitRange

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: LimitRange, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: LimitRange

    +

    request: function

    +

    ▸ (): Promise‹LimitRange

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file 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 d7c1b6ee9a..2419f62383 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1185,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:93

    Parameters:

    @@ -1206,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:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:101


    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:

    @@ -1271,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:126

    Parameters:

    @@ -1304,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:147

    Parameters:

    @@ -1327,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:139

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

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

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

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

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

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

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1409,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:73

    Parameters:

    @@ -1430,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:81

    Parameters:

    @@ -1451,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:85

    Parameters:

    @@ -1472,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:77

    Parameters:

    @@ -1493,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:89

    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 31cb36dfba..27b86c6cd5 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -904,8 +904,8 @@
  • - - contextNs + + contextReady
  • @@ -953,8 +953,8 @@
  • - - Protected storage + + Static defaultContext
  • @@ -973,8 +973,36 @@ @@ -1311,18 +1388,22 @@

    Accessors#

    @@ -1335,12 +1416,15 @@
  • defaultSorting
  • filterItemsOnLoad
  • getAllByNs
  • +
  • getById
  • getByLabel
  • getByName
  • getByPath
  • -
  • getContextParams
  • -
  • getDummyNamespace
  • +
  • getIndexById
  • +
  • getItems
  • getStatuses
  • +
  • getSubscribeApis
  • +
  • getTotalCount
  • hasContext
  • isSelected
  • isSelectedAll
  • @@ -1349,16 +1433,21 @@
  • loadFromPath
  • loadItem
  • loadItems
  • -
  • onWatchApiEvent
  • +
  • mergeItems
  • +
  • onContextChange
  • +
  • reloadAll
  • remove
  • removeItem
  • removeSelectedItems
  • reset
  • +
  • resetContext
  • +
  • resetOnError
  • resetSelection
  • select
  • setContext
  • sortItems
  • subscribe
  • +
  • toggleAll
  • toggleContext
  • toggleSelection
  • toggleSelectionAll
  • @@ -1366,90 +1455,113 @@
  • update
  • updateFromEventsBuffer
  • updateItem
  • -
  • updateUrl
  • Constructors#

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

    Returns: NamespaceStore

    Properties#

    api#

    api: KubeApiNamespace‹›› = namespacesApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:12

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:34


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


    -

    contextNs#

    -

    contextNs: IObservableArray‹string› = observable.array()

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:13

    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26


    Protected eventsBuffer#

    -

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:172

    +

    Defined in src/renderer/kube-object.store.ts:259


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


    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

    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    Accessors#

    -

    initNamespaces#

    -

    get initNamespaces(): string[]

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:17

    +

    allowedNamespaces#

    +

    get allowedNamespaces(): string[]

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:94

    Returns: string[]


    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Namespace[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Namespace[]

    +
    +

    contextNamespaces#

    +

    get contextNamespaces(): string[]

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:101

    +

    Returns: string[]

    +
    +

    hasAllContexts#

    +

    get hasAllContexts(): boolean

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:150

    +

    Returns: boolean

    +

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

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

    Returns: Generator‹T, void, undefined›


    Protected bindWatchEventsUpdater#

    -

    bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    bindWatchEventsUpdater(delay: number): void

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:174

    +

    Defined in src/renderer/kube-object.store.ts:261

    Parameters:

    @@ -1467,12 +1579,12 @@
    -

    Returns: IReactionDisposer

    +

    Returns: void


    create#

    create(params: object, data?: Partial‹Namespace›): Promise‹Namespace

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:143

    +

    Defined in src/renderer/kube-object.store.ts:230

    Parameters:

    params: object

    @@ -1500,7 +1612,7 @@

    createItem(params: object, data?: Partial‹Namespace›): Promise‹Namespace

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:139

    +

    Defined in src/renderer/kube-object.store.ts:226

    Parameters:

    params: object

    @@ -1527,7 +1639,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:

    @@ -1548,7 +1660,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:130

    Parameters:

    @@ -1569,7 +1681,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:63

    Parameters:

    @@ -1594,10 +1706,31 @@

    Returns: Namespace[]


    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +

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

    Parameters:

    @@ -1619,7 +1752,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:77

    Parameters:

    @@ -1644,7 +1777,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:85

    Parameters:

    @@ -1662,14 +1795,10 @@

    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

    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    Parameters:

    @@ -1680,17 +1809,23 @@ - +
    nameid string
    -

    Returns: Namespace‹›

    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Namespace[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Namespace[]


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

    Parameters:

    @@ -1708,9 +1843,22 @@

    Returns: Record‹string, number›


    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi‹any›[]

    +

    Overrides KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:111

    +

    Returns: KubeApi‹any›[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +

    hasContext#

    -

    hasContext(namespace: string | string[]): boolean

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:91

    +

    hasContext(namespaces: string | string[]): boolean

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:146

    Parameters:

    @@ -1721,7 +1869,7 @@ - + @@ -1731,7 +1879,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:125

    Parameters:

    namespacenamespaces string | string[]
    @@ -1752,7 +1900,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:159

    Parameters:

    @@ -1775,7 +1923,7 @@

    load#

    load(params: object): Promise‹Namespace

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:118

    +

    Defined in src/renderer/kube-object.store.ts:205

    Parameters:

    params: object

    @@ -1799,16 +1947,36 @@

    Returns: Promise‹Namespace


    loadAll#

    -

    loadAll(): Promise‹void›

    +

    loadAll(options: object): Promise‹void | Namespace[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    -

    Returns: Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    +
    + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Namespace[]›


    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:133

    +

    Defined in src/renderer/kube-object.store.ts:220

    Parameters:

    @@ -1830,7 +1998,7 @@

    loadItem(params: object): Promise‹Namespace

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:200

    Parameters:

    params: object

    @@ -1854,9 +2022,9 @@

    Returns: Promise‹Namespace


    Protected loadItems#

    -

    loadItems(namespaces?: string[]): Promise‹Namespace‹›[]›

    +

    loadItems(params: KubeObjectStoreLoadingParams): Promise‹Namespace‹›[]›

    Overrides KubeObjectStore.loadItems

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:60

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:120

    Parameters:

    @@ -1867,38 +2035,111 @@ + + + + +
    paramsKubeObjectStoreLoadingParams
    +

    Returns: Promise‹Namespace‹›[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Namespace[], __namedParameters: object): Namespace[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Namespace[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Namespace[]

    +
    +

    onContextChange#

    +

    onContextChange(callback: function, opts: IReactionOptions): IReactionDisposer

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:51

    +

    Parameters:

    +

    callback: function

    +

    ▸ (contextNamespaces: string[]): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    contextNamespacesstring[]
    +

    Default value opts: IReactionOptions= {}

    +

    Returns: IReactionDisposer

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    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

    +

    Returns: Promise‹void | T[]›


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

    Parameters:

    @@ -1919,7 +2160,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:119

    Parameters:

    item: Namespace

    request: function

    @@ -1930,25 +2171,51 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:254

    Returns: Promise‹void[]›


    reset#

    reset(): void

    -

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:103

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    resetContext#

    +

    resetContext(): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:142

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    errorany

    Returns: void


    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:166

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

    Parameters:

    @@ -1967,8 +2234,8 @@

    Returns: void


    setContext#

    -

    setContext(namespaces: string[]): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:87

    +

    setContext(namespace: string | string[]): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:135

    Parameters:

    @@ -1979,8 +2246,8 @@ - - + +
    namespacesstring[]namespacestring | string[]
    @@ -1989,7 +2256,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:43

    Parameters:

    @@ -2020,9 +2287,10 @@

    Returns: Namespace[]


    subscribe#

    -

    subscribe(apis: KubeApiNamespace‹››[]): (Anonymous function)

    -

    Overrides KubeObjectStore.subscribe

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:45

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    Parameters:

    @@ -2035,16 +2303,36 @@ - - + +
    apisKubeApiNamespace‹››[][this.api]KubeApi‹any›[]this.getSubscribeApis()

    Returns: (Anonymous function)


    +

    toggleAll#

    +

    toggleAll(showAll?: boolean): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:164

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    showAll?boolean
    +

    Returns: void

    +

    toggleContext#

    toggleContext(namespace: string): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:97

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:155

    Parameters:

    @@ -2065,7 +2353,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:140

    Parameters:

    @@ -2086,7 +2374,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:149

    Parameters:

    @@ -2109,7 +2397,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:135

    Parameters:

    @@ -2130,7 +2418,7 @@

    update#

    update(item: Namespace, data: Partial‹Namespace›): Promise‹Namespace

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:152

    +

    Defined in src/renderer/kube-object.store.ts:239

    Parameters:

    @@ -2155,38 +2443,18 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:190

    +

    Defined in src/renderer/kube-object.store.ts:349

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

    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

    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 ed0933f0b6..3014acc1bc 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1201,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:93

    Parameters:

    @@ -1222,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:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:101


    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:

    @@ -1308,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:126

    Parameters:

    @@ -1341,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:147

    Parameters:

    @@ -1364,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:139

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

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

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

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

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

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

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1451,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:73

    Parameters:

    @@ -1472,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:81

    Parameters:

    @@ -1493,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:85

    Parameters:

    @@ -1514,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:77

    Parameters:

    @@ -1535,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:89

    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 7ff78b41de..f4847dcdf8 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -901,6 +901,13 @@ bufferSize + + +
  • + + contextReady + +
  • @@ -943,6 +950,13 @@ selectedItemsIds +
  • + +
  • + + Static defaultContext + +
  • @@ -958,6 +972,20 @@
    @@ -1382,12 +1492,12 @@
    -

    Returns: IReactionDisposer

    +

    Returns: void


    create#

    create(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:143

    +

    Defined in src/renderer/kube-object.store.ts:230

    Parameters:

    params: object

    @@ -1415,7 +1525,7 @@

    createItem(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:139

    +

    Defined in src/renderer/kube-object.store.ts:226

    Parameters:

    params: object

    @@ -1442,7 +1552,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:

    @@ -1463,7 +1573,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:130

    Parameters:

    @@ -1484,7 +1594,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:63

    Parameters:

    @@ -1509,10 +1619,31 @@

    Returns: NetworkPolicy[]


    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +

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

    Parameters:

    @@ -1534,7 +1665,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:77

    Parameters:

    @@ -1559,7 +1690,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:85

    Parameters:

    @@ -1577,10 +1708,37 @@

    Returns: NetworkPolicy


    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: NetworkPolicy[]

    +

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

    Parameters:

    @@ -1598,10 +1756,23 @@

    Returns: Record‹string, number›


    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +

    isSelected#

    isSelected(item: NetworkPolicy): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1622,7 +1793,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:159

    Parameters:

    @@ -1645,7 +1816,7 @@

    load#

    load(params: object): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:118

    +

    Defined in src/renderer/kube-object.store.ts:205

    Parameters:

    params: object

    @@ -1669,16 +1840,36 @@

    Returns: Promise‹NetworkPolicy


    loadAll#

    -

    loadAll(): Promise‹void›

    +

    loadAll(options: object): Promise‹void | NetworkPolicy[]›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    -

    Returns: Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    +
    + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | NetworkPolicy[]›


    loadFromPath#

    loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:133

    +

    Defined in src/renderer/kube-object.store.ts:220

    Parameters:

    @@ -1700,7 +1891,7 @@

    loadItem(params: object): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:200

    Parameters:

    params: object

    @@ -1724,11 +1915,12 @@

    Returns: Promise‹NetworkPolicy


    Protected loadItems#

    -

    loadItems(allowedNamespaces?: string[]): Promise‹NetworkPolicy[]›

    +

    loadItems(__namedParameters: object): 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:106

    Parameters:

    +

    __namedParameters: object

    @@ -1738,18 +1930,63 @@ - + + + + +
    allowedNamespaces?apiKubeApi‹any›
    namespaces string[]

    Returns: Promise‹NetworkPolicy[]›


    -

    Protected onWatchApiEvent#

    -

    onWatchApiEvent(evt: IKubeWatchEvent): void

    -

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:184

    +

    Protected mergeItems#

    +

    mergeItems(partialItems: NetworkPolicy[], __namedParameters: object): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    Parameters:

    +

    partialItems: NetworkPolicy[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: NetworkPolicy[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    @@ -1759,17 +1996,25 @@ - - + + + + + + + + + +
    evtIKubeWatchEventforce?boolean
    merge?boolean
    namespaces?string[]
    -

    Returns: void

    +

    Returns: Promise‹void | T[]›


    remove#

    remove(item: NetworkPolicy): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:161

    +

    Defined in src/renderer/kube-object.store.ts:248

    Parameters:

    @@ -1790,7 +2035,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:119

    Parameters:

    item: NetworkPolicy

    request: function

    @@ -1801,25 +2046,46 @@

    removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:254

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

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    errorany

    Returns: void


    resetSelection#

    resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:166

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

    Parameters:

    @@ -1840,7 +2106,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:43

    Parameters:

    @@ -1871,10 +2137,10 @@

    Returns: NetworkPolicy[]


    subscribe#

    -

    subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:180

    +

    Defined in src/renderer/kube-object.store.ts:271

    Parameters:

    @@ -1887,8 +2153,8 @@ - - + +
    apisKubeApi‹T›[][this.api]KubeApi‹any›[]this.getSubscribeApis()
    @@ -1897,7 +2163,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:140

    Parameters:

    @@ -1918,7 +2184,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:149

    Parameters:

    @@ -1941,7 +2207,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:135

    Parameters:

    @@ -1962,7 +2228,7 @@

    update#

    update(item: NetworkPolicy, data: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:152

    +

    Defined in src/renderer/kube-object.store.ts:239

    Parameters:

    @@ -1987,13 +2253,13 @@

    Protected updateFromEventsBuffer#

    updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:190

    +

    Defined in src/renderer/kube-object.store.ts:349

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

    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 1ad622e583..6c1c174bec 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1273,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:93

    Parameters:

    @@ -1294,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:99


    kind#

    kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:100


    metadata#

    metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:101


    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:

    @@ -1442,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:126

    Parameters:

    @@ -1481,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:147

    Parameters:

    @@ -1503,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:139

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

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

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

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

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

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

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

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

    Returns: object


    update#

    updateT›(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:183

    Type parameters:

    T: KubeObject

    Parameters:

    @@ -1631,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:73

    Parameters:

    @@ -1652,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:81

    Parameters:

    @@ -1673,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:85

    Parameters:

    @@ -1694,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:77

    Parameters:

    @@ -1715,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:89

    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 ee7cb38669..ac638a6be0 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -974,8 +974,8 @@
  • - - Static parseApi + + Protected watchDisposer
  • @@ -1074,6 +1074,13 @@ list + + +
  • + + Protected modifyWatchEvent + +
  • @@ -1116,13 +1123,6 @@ watch -
  • - -
  • - - Static watchAll - -
  • @@ -1169,7 +1169,7 @@
  • options
  • request
  • resourceVersions
  • -
  • parseApi
  • +
  • watchDisposer
  • Accessors#

    Constructors#

    constructor#

    + new NodesApi(options: IKubeApiOptions‹Node›): NodesApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:117

    Parameters:

    @@ -1219,84 +1219,86 @@

    apiBase#

    apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:104

    +

    Defined in src/renderer/api/kube-api.ts:106


    apiGroup#

    apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:106

    +

    Defined in src/renderer/api/kube-api.ts:108


    apiPrefix#

    apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:105

    +

    Defined in src/renderer/api/kube-api.ts:107


    apiResource#

    apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:109

    +

    Defined in src/renderer/api/kube-api.ts:111


    apiVersion#

    apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:107

    +

    Defined in src/renderer/api/kube-api.ts:109


    Optional apiVersionPreferred#

    apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:108

    +

    Defined in src/renderer/api/kube-api.ts:110


    isNamespaced#

    isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:110

    +

    Defined in src/renderer/api/kube-api.ts:112


    kind#

    kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:103

    +

    Defined in src/renderer/api/kube-api.ts:105


    objectConstructor#

    objectConstructor: IKubeObjectConstructor‹Node

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:112

    +

    Defined in src/renderer/api/kube-api.ts:114


    Protected options#

    options: IKubeApiOptions‹Node

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:116

    +

    Defined in src/renderer/api/kube-api.ts:119


    Protected request#

    request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:113

    +

    Defined in src/renderer/api/kube-api.ts:115


    Protected resourceVersions#

    resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:114

    +

    Defined in src/renderer/api/kube-api.ts:116


    -

    Static parseApi#

    -

    parseApi: parseKubeApi = parseKubeApi

    -

    Inherited from KubeApi.parseApi

    -

    Defined in src/renderer/api/kube-api.ts:95

    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:

    +

    ▸ (): void

    Accessors#

    apiVersionWithGroup#

    get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:144

    +

    Defined in src/renderer/api/kube-api.ts:147

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:206

    +

    Defined in src/renderer/api/kube-api.ts:209

    Returns: Promise‹void›


    create#

    create(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:326

    +

    Defined in src/renderer/api/kube-api.ts:329

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1326,7 +1328,7 @@

    delete#

    delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:353

    +

    Defined in src/renderer/api/kube-api.ts:356

    Parameters:

    __namedParameters: object

    @@ -1355,7 +1357,7 @@

    get#

    get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:318

    +

    Defined in src/renderer/api/kube-api.ts:321

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1384,13 +1386,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:239

    +

    Defined in src/renderer/api/kube-api.ts:242

    Parameters:

    @@ -1413,7 +1415,7 @@

    getUrl#

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:247

    +

    Defined in src/renderer/api/kube-api.ts:250

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1443,7 +1445,7 @@

    getWatchUrl#

    getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:360

    +

    Defined in src/renderer/api/kube-api.ts:363

    Parameters:

    @@ -1471,7 +1473,7 @@

    list#

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:310

    +

    Defined in src/renderer/api/kube-api.ts:313

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1493,10 +1495,31 @@

    Optional query: IKubeApiQueryParams

    Returns: Promise‹Node[]›


    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:446

    +

    Parameters:

    +
    + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +

    Protected normalizeQuery#

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:259

    +

    Defined in src/renderer/api/kube-api.ts:262

    Parameters:

    @@ -1519,7 +1542,7 @@

    Protected parseResponse#

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:271

    +

    Defined in src/renderer/api/kube-api.ts:274

    Parameters:

    @@ -1544,7 +1567,7 @@

    refreshResourceVersion#

    refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:243

    +

    Defined in src/renderer/api/kube-api.ts:246

    Parameters:

    Optional params: object

    @@ -1566,7 +1589,7 @@

    setResourceVersion#

    setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:235

    +

    Defined in src/renderer/api/kube-api.ts:238

    Parameters:

    @@ -1594,7 +1617,7 @@

    update#

    update(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:344

    +

    Defined in src/renderer/api/kube-api.ts:347

    Parameters:

    Default value __namedParameters: object= {}

    @@ -1622,32 +1645,28 @@

    Returns: Promise‹Node


    watch#

    -

    watch(): function

    +

    watch(opts: KubeApiWatchOptions): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:368

    -

    Returns: function

    -

    ▸ (): void

    -
    -

    Static watchAll#

    -

    watchAll(...apis: KubeApi[]): (Anonymous function)

    -

    Inherited from KubeApi.watchAll

    -

    Defined in src/renderer/api/kube-api.ts:97

    +

    Defined in src/renderer/api/kube-api.ts:371

    Parameters:

    + - - + + +
    Name TypeDefault
    ...apisKubeApi[]optsKubeApiWatchOptions{ namespace: "" }
    -

    Returns: (Anonymous function)

    +

    Returns: function

    +

    ▸ (): void

    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 26bb1a4ac3..b193ba0f95 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -901,6 +901,13 @@ bufferSize + + +
  • + + contextReady + +
  • @@ -971,6 +978,13 @@ selectedItemsIds +
  • + +
  • + + Static defaultContext + +
  • @@ -986,6 +1000,20 @@
    +
    + + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/classes/lensmainextension/index.html b/latest/extensions/api/classes/lensmainextension/index.html index 107b4a934e..1b0c652f1f 100644 --- a/latest/extensions/api/classes/lensmainextension/index.html +++ b/latest/extensions/api/classes/lensmainextension/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -1086,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

    @@ -1119,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 @@ -1183,7 +1183,7 @@ folder name.


    navigateP›(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:

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

    @@ -1247,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 42c3509ece..9be8c08398 100644 --- a/latest/extensions/api/classes/lensrendererextension/index.html +++ b/latest/extensions/api/classes/lensrendererextension/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -915,6 +915,13 @@ clusterPages + + +
  • + + commands + +
  • @@ -1133,6 +1140,7 @@
  • clusterFeatures
  • clusterPageMenus
  • clusterPages
  • +
  • commands
  • globalPageMenus
  • globalPages
  • id
  • @@ -1166,7 +1174,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

    @@ -1199,98 +1207,102 @@

    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

    +

    clusterPageMenus: ClusterPageMenuRegistration[] = []

    +

    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

    +
    +

    commands#

    +

    commands: CommandRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:18


    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 @@ -1299,7 +1311,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:35

    Defines if extension is enabled for a given cluster. Defaults to true.

    Parameters:

    @@ -1320,7 +1332,7 @@ folder name.


    navigateP›(pageId?: string, params?: P): Promise‹void›

    -

    Defined in src/extensions/lens-renderer-extension.ts:19

    +

    Defined in src/extensions/lens-renderer-extension.ts:20

    Type parameters:

    P: object

    Parameters:

    @@ -1347,19 +1359,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:

    @@ -1380,7 +1392,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 8e23cff5ff..9fa9593766 100644 --- a/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html +++ b/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -892,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.tsx:12


    INFO#

    INFO: = "info"

    -

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

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:13


    OK#

    OK: = "ok"

    -

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

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx: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 cb32a86bc8..c0340d0f85 100644 --- a/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html +++ b/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -932,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 4d0342ce60..5263da927a 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -892,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 9e95e9fe6a..1d2ff6913f 100644 --- a/latest/extensions/api/globals/index.html +++ b/latest/extensions/api/globals/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • diff --git a/latest/extensions/api/index.html b/latest/extensions/api/index.html index 8f9d3578f9..abf1898ced 100644 --- a/latest/extensions/api/index.html +++ b/latest/extensions/api/index.html @@ -600,7 +600,7 @@
  • - Working with mobx + Working with MobX
  • 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 5c871b2f46..5203ec55e4 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -911,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 fce1085234..e09d8133c7 100644 --- a/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html +++ b/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -962,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 9b02a1b31f..aa2dd04ee6 100644 --- a/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html +++ b/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -930,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 169bfdecdb..3938fd2512 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -895,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 174cf78684..deb2a836bf 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -895,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 266d73d81c..235068c927 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -887,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 13a2082fe3..3e4d63d7fd 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -903,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_.clusterpagemenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html new file mode 100644 index 0000000000..cc492f4caa --- /dev/null +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html @@ -0,0 +1,1019 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterPageMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterPageMenuRegistration#

    +

    Hierarchy#

    + +

    ClusterPageMenuRegistration

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageMenuComponents

    +

    Inherited from PageMenuRegistration.components

    +

    Defined in src/extensions/registries/page-menu-registry.ts:12

    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/extensions/registries/page-menu-registry.ts:16

    +
    +

    Optional parentId#

    +

    parentId? : string

    +

    Defined in src/extensions/registries/page-menu-registry.ts:17

    +
    +

    Optional target#

    +

    target? : PageTarget

    +

    Inherited from PageMenuRegistration.target

    +

    Defined in src/extensions/registries/page-menu-registry.ts:10

    +
    +

    title#

    +

    title: React.ReactNode

    +

    Inherited from PageMenuRegistration.title

    +

    Defined in src/extensions/registries/page-menu-registry.ts:11

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html index c134ffc3a8..3618cbe972 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -887,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 6a049f529b..bbaaf6ac56 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -911,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 975244d499..3a602016a1 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -887,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 27c691c996..13b26457a2 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -903,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 e5b0ab61b7..570957e679 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -903,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_.pagecomponentprops/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html new file mode 100644 index 0000000000..52a258aa1d --- /dev/null +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html @@ -0,0 +1,977 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponentProps ‹**P**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html index 696c2ce635..a9efc2cd2a 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -887,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:24

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html index 45f7e4906f..8ea41d5f46 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -887,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:21

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html index e7e7c92b8f..98eae589c3 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -893,6 +893,7 @@
    • PageMenuRegistration
    +

    ClusterPageMenuRegistration

    Index#

    Properties#

      @@ -903,15 +904,15 @@

      Properties#

      components#

      components: PageMenuComponents

      -

      Defined in src/extensions/registries/page-menu-registry.ts:18

      +

      Defined in src/extensions/registries/page-menu-registry.ts:12


      Optional target#

      -

      target? : PageMenuTarget

      -

      Defined in src/extensions/registries/page-menu-registry.ts:16

      +

      target? : PageTarget

      +

      Defined in src/extensions/registries/page-menu-registry.ts:10


      title#

      title: React.ReactNode

      -

      Defined in src/extensions/registries/page-menu-registry.ts:17

      +

      Defined in src/extensions/registries/page-menu-registry.ts:11

      diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pageparams/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pageparams/index.html new file mode 100644 index 0000000000..6e2d7baf29 --- /dev/null +++ b/latest/extensions/api/interfaces/_interfaces_index_.pageparams/index.html @@ -0,0 +1,938 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageParams ‹**V**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + +
      + + + +
      + +
      + +
      + + + + +
      +
      + + +
      +
      +
      + + + +
      +
      +
      + + + + + + + +
      +
      +
      + + +
      +
      +
      + + + +
      +
      + + + +

      Interface: PageParams ‹V#

      +

      Type parameters#

      +

      V

      +

      Hierarchy#

      +
        +
      • PageParams
      • +
      +

      Indexable#

      +
        +
      • [ paramName: string]: V
      • +
      + + + + + + + +
      +
      +
      +
      + + + + +
      + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html index e76cd2552a..79777478d7 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -856,15 +856,15 @@
    • - - Optional exact + + Optional id
    • - - Optional id + + Optional params
    • @@ -897,33 +897,23 @@

      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".

      +

      Defined in src/extensions/registries/page-registry.ts:17


      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) +

      Defined in src/extensions/registries/page-registry.ts:15

      +

      Page ID, part of extension's page url, must be unique within same extension When not provided, first registered page without "id" would be used for page-menus without target.pageId for same extension

      +
      +

      Optional params#

      +

      params? : PageParams‹string | ExtensionPageParamInit›

      +

      Defined in src/extensions/registries/page-registry.ts:16

      diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html new file mode 100644 index 0000000000..463f70489e --- /dev/null +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageTarget ‹**P**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + +
      + + + +
      + +
      + +
      + + + + +
      +
      + + +
      +
      +
      + + + +
      +
      +
      + + + + + + + +
      +
      +
      + + +
      +
      +
      + + + +
      + +
      +
      +
      + + + + +
      + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html b/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html new file mode 100644 index 0000000000..07ed99abba --- /dev/null +++ b/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html @@ -0,0 +1,1015 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: RegisteredPage - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      + +
      + + + +
      + +
      + +
      + + + + +
      +
      + + +
      +
      +
      + + + +
      +
      +
      + + + + + + + +
      +
      +
      + + +
      +
      +
      + + + +
      +
      + + + +

      Interface: RegisteredPage#

      +

      Hierarchy#

      +
        +
      • RegisteredPage
      • +
      +

      Index#

      +

      Properties#

      + +

      Properties#

      +

      components#

      +

      components: PageComponents

      +

      Defined in src/extensions/registries/page-registry.ts:48

      +
      +

      extensionId#

      +

      extensionId: string

      +

      Defined in src/extensions/registries/page-registry.ts:45

      +
      +

      id#

      +

      id: string

      +

      Defined in src/extensions/registries/page-registry.ts:44

      +
      +

      params#

      +

      params: PageParamsPageParam

      +

      Defined in src/extensions/registries/page-registry.ts:47

      +
      +

      url#

      +

      url: string

      +

      Defined in src/extensions/registries/page-registry.ts:46

      + + + + + + + +
      +
      +
      +
      + + + + +
      + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html index c0b686496b..4792b9564d 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -848,6 +848,13 @@
    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 e514e5f5ff..11f5b67c9f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -935,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:21


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


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


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


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


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

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

    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 c5cfb10782..d7cdfab2de 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • 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 2f04160680..98b0a00df8 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -895,11 +895,11 @@

    Properties#

    Optional center#

    center? : boolean

    -

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

    +

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


    Optional className#

    className? : string

    -

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

    +

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

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html index 6a0d804527..7862ec737d 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -951,47 +951,47 @@

    Properties#

    Optional animated#

    animated? : boolean

    -

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

    +

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


    Optional className#

    className? : string

    -

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

    +

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


    Optional close#

    close? : function

    -

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

    +

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

    Type declaration:

    ▸ (): void


    Optional isOpen#

    isOpen? : boolean

    -

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

    +

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


    Optional modal#

    modal? : boolean

    -

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

    +

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


    Optional onClose#

    onClose? : function

    -

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

    +

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

    Type declaration:

    ▸ (): void


    Optional onOpen#

    onOpen? : function

    -

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

    +

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

    Type declaration:

    ▸ (): void


    Optional open#

    open? : function

    -

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

    +

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

    Type declaration:

    ▸ (): void


    Optional pinned#

    pinned? : boolean

    -

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

    +

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

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html index 78df0307a5..8413cd6951 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -2943,214 +2943,214 @@

    Optional about#

    about? : string

    Inherited from ButtonProps.about

    -

    Defined in node_modules/@types/react/index.d.ts:1775

    +

    Defined in node_modules/@types/react/index.d.ts:1777


    Optional accessKey#

    accessKey? : string

    Inherited from ButtonProps.accessKey

    -

    Defined in node_modules/@types/react/index.d.ts:1751

    +

    Defined in node_modules/@types/react/index.d.ts:1753


    Optional aria-activedescendant#

    aria-activedescendant? : string

    Inherited from ButtonProps.aria-activedescendant

    -

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1562

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1569

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1574

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1579

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1584

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1589

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1596

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1601

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1606

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1611

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1616

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1623

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1628

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1635

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1640

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1647

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1652

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1669

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1675

    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.

    @@ -3158,161 +3158,161 @@ between DOM elements where the DOM hierarchy cannot be used to represent the rel

    Optional aria-placeholder#

    aria-placeholder? : string

    Inherited from ButtonProps.aria-placeholder

    -

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defined in node_modules/@types/react/index.d.ts:1680

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1685

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1690

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1695

    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"

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    Inherited from ButtonProps.aria-relevant

    -

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1704

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1709

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1714

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1719

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1724

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1735

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1742

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1787


    Optional autoCorrect#

    autoCorrect? : string

    Inherited from ButtonProps.autoCorrect

    -

    Defined in node_modules/@types/react/index.d.ts:1786

    +

    Defined in node_modules/@types/react/index.d.ts:1788


    Optional autoSave#

    autoSave? : string

    Inherited from ButtonProps.autoSave

    -

    Defined in node_modules/@types/react/index.d.ts:1787

    +

    Defined in node_modules/@types/react/index.d.ts:1789


    Optional children#

    children? : ReactNode

    Inherited from PageLayoutProps.children

    -

    Defined in node_modules/@types/react/index.d.ts:1348

    +

    Defined in node_modules/@types/react/index.d.ts:1350


    Optional className#

    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

    Inherited from ButtonProps.color

    -

    Defined in node_modules/@types/react/index.d.ts:1788

    +

    Defined in node_modules/@types/react/index.d.ts:1790


    Optional contentEditable#

    contentEditable? : Booleanish | "inherit"

    Inherited from ButtonProps.contentEditable

    -

    Defined in node_modules/@types/react/index.d.ts:1753

    +

    Defined in node_modules/@types/react/index.d.ts:1755


    Optional contextMenu#

    contextMenu? : string

    Inherited from ButtonProps.contextMenu

    -

    Defined in node_modules/@types/react/index.d.ts:1754

    +

    Defined in node_modules/@types/react/index.d.ts:1756


    Optional dangerouslySetInnerHTML#

    dangerouslySetInnerHTML? : object

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    -

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    Type declaration:

    • __html: string
    • @@ -3321,1002 +3321,1002 @@ A hint could be a sample value or a brief description of the expected format.

      Optional datatype#

      datatype? : string

      Inherited from ButtonProps.datatype

      -

      Defined in node_modules/@types/react/index.d.ts:1776

      +

      Defined in node_modules/@types/react/index.d.ts:1778


      Optional defaultChecked#

      defaultChecked? : boolean

      Inherited from ButtonProps.defaultChecked

      -

      Defined in node_modules/@types/react/index.d.ts:1745

      +

      Defined in node_modules/@types/react/index.d.ts:1747


      Optional defaultValue#

      -

      defaultValue? : string | number | string[]

      +

      defaultValue? : string | number | ReadonlyArray‹string›

      Inherited from ButtonProps.defaultValue

      -

      Defined in node_modules/@types/react/index.d.ts:1746

      +

      Defined in node_modules/@types/react/index.d.ts:1748


      Optional dir#

      dir? : string

      Inherited from ButtonProps.dir

      -

      Defined in node_modules/@types/react/index.d.ts:1755

      +

      Defined in node_modules/@types/react/index.d.ts:1757


      Optional draggable#

      draggable? : Booleanish

      Inherited from ButtonProps.draggable

      -

      Defined in node_modules/@types/react/index.d.ts:1756

      +

      Defined in node_modules/@types/react/index.d.ts:1758


      Optional hidden#

      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

      Inherited from ButtonProps.id

      -

      Defined in node_modules/@types/react/index.d.ts:1758

      +

      Defined in node_modules/@types/react/index.d.ts:1760


      Optional inlist#

      inlist? : any

      Inherited from ButtonProps.inlist

      -

      Defined in node_modules/@types/react/index.d.ts:1777

      +

      Defined in node_modules/@types/react/index.d.ts:1779


      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

      +

      Defined in node_modules/@types/react/index.d.ts:1805

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1810

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1794


      Optional itemProp#

      itemProp? : string

      Inherited from ButtonProps.itemProp

      -

      Defined in node_modules/@types/react/index.d.ts:1789

      +

      Defined in node_modules/@types/react/index.d.ts:1791


      Optional itemRef#

      itemRef? : string

      Inherited from ButtonProps.itemRef

      -

      Defined in node_modules/@types/react/index.d.ts:1793

      +

      Defined in node_modules/@types/react/index.d.ts:1795


      Optional itemScope#

      itemScope? : boolean

      Inherited from ButtonProps.itemScope

      -

      Defined in node_modules/@types/react/index.d.ts:1790

      +

      Defined in node_modules/@types/react/index.d.ts:1792


      Optional itemType#

      itemType? : string

      Inherited from ButtonProps.itemType

      -

      Defined in node_modules/@types/react/index.d.ts:1791

      +

      Defined in node_modules/@types/react/index.d.ts:1793


      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

      Inherited from ButtonProps.lang

      -

      Defined in node_modules/@types/react/index.d.ts:1759

      +

      Defined in node_modules/@types/react/index.d.ts:1761


      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›

      Inherited from PageLayoutProps.onAbort

      -

      Defined in node_modules/@types/react/index.d.ts:1404

      +

      Defined in node_modules/@types/react/index.d.ts:1406


      Optional onAbortCapture#

      onAbortCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onAbortCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1405

      +

      Defined in node_modules/@types/react/index.d.ts:1407


      Optional onAnimationEnd#

      onAnimationEnd? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1534

      +

      Defined in node_modules/@types/react/index.d.ts:1536


      Optional onAnimationEndCapture#

      onAnimationEndCapture? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1535

      +

      Defined in node_modules/@types/react/index.d.ts:1537


      Optional onAnimationIteration#

      onAnimationIteration? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationIteration

      -

      Defined in node_modules/@types/react/index.d.ts:1536

      +

      Defined in node_modules/@types/react/index.d.ts:1538


      Optional onAnimationIterationCapture#

      onAnimationIterationCapture? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationIterationCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1537

      +

      Defined in node_modules/@types/react/index.d.ts:1539


      Optional onAnimationStart#

      onAnimationStart? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationStart

      -

      Defined in node_modules/@types/react/index.d.ts:1532

      +

      Defined in node_modules/@types/react/index.d.ts:1534


      Optional onAnimationStartCapture#

      onAnimationStartCapture? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1533

      +

      Defined in node_modules/@types/react/index.d.ts:1535


      Optional onAuxClick#

      onAuxClick? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onAuxClick

      -

      Defined in node_modules/@types/react/index.d.ts:1450

      +

      Defined in node_modules/@types/react/index.d.ts:1452


      Optional onAuxClickCapture#

      onAuxClickCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onAuxClickCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1451

      +

      Defined in node_modules/@types/react/index.d.ts:1453


      Optional onBeforeInput#

      onBeforeInput? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onBeforeInput

      -

      Defined in node_modules/@types/react/index.d.ts:1378

      +

      Defined in node_modules/@types/react/index.d.ts:1380


      Optional onBeforeInputCapture#

      onBeforeInputCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onBeforeInputCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1379

      +

      Defined in node_modules/@types/react/index.d.ts:1381


      Optional onBlur#

      onBlur? : FocusEventHandler‹any›

      Inherited from PageLayoutProps.onBlur

      -

      Defined in node_modules/@types/react/index.d.ts:1372

      +

      Defined in node_modules/@types/react/index.d.ts:1374


      Optional onBlurCapture#

      onBlurCapture? : FocusEventHandler‹any›

      Inherited from PageLayoutProps.onBlurCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1373

      +

      Defined in node_modules/@types/react/index.d.ts:1375


      Optional onCanPlay#

      onCanPlay? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onCanPlay

      -

      Defined in node_modules/@types/react/index.d.ts:1406

      +

      Defined in node_modules/@types/react/index.d.ts:1408


      Optional onCanPlayCapture#

      onCanPlayCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onCanPlayCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1407

      +

      Defined in node_modules/@types/react/index.d.ts:1409


      Optional onCanPlayThrough#

      onCanPlayThrough? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onCanPlayThrough

      -

      Defined in node_modules/@types/react/index.d.ts:1408

      +

      Defined in node_modules/@types/react/index.d.ts:1410


      Optional onCanPlayThroughCapture#

      onCanPlayThroughCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onCanPlayThroughCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1409

      +

      Defined in node_modules/@types/react/index.d.ts:1411


      Optional onChange#

      onChange? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onChange

      -

      Defined in node_modules/@types/react/index.d.ts:1376

      +

      Defined in node_modules/@types/react/index.d.ts:1378


      Optional onChangeCapture#

      onChangeCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onChangeCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1377

      +

      Defined in node_modules/@types/react/index.d.ts:1379


      Optional onClick#

      onClick? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onClick

      -

      Defined in node_modules/@types/react/index.d.ts:1452

      +

      Defined in node_modules/@types/react/index.d.ts:1454


      Optional onClickCapture#

      onClickCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onClickCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1453

      +

      Defined in node_modules/@types/react/index.d.ts:1455


      Optional onCompositionEnd#

      onCompositionEnd? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1362

      +

      Defined in node_modules/@types/react/index.d.ts:1364


      Optional onCompositionEndCapture#

      onCompositionEndCapture? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1363

      +

      Defined in node_modules/@types/react/index.d.ts:1365


      Optional onCompositionStart#

      onCompositionStart? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionStart

      -

      Defined in node_modules/@types/react/index.d.ts:1364

      +

      Defined in node_modules/@types/react/index.d.ts:1366


      Optional onCompositionStartCapture#

      onCompositionStartCapture? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1365

      +

      Defined in node_modules/@types/react/index.d.ts:1367


      Optional onCompositionUpdate#

      onCompositionUpdate? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionUpdate

      -

      Defined in node_modules/@types/react/index.d.ts:1366

      +

      Defined in node_modules/@types/react/index.d.ts:1368


      Optional onCompositionUpdateCapture#

      onCompositionUpdateCapture? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionUpdateCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1367

      +

      Defined in node_modules/@types/react/index.d.ts:1369


      Optional onContextMenu#

      onContextMenu? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onContextMenu

      -

      Defined in node_modules/@types/react/index.d.ts:1454

      +

      Defined in node_modules/@types/react/index.d.ts:1456


      Optional onContextMenuCapture#

      onContextMenuCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onContextMenuCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1455

      +

      Defined in node_modules/@types/react/index.d.ts:1457


      Optional onCopy#

      onCopy? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onCopy

      -

      Defined in node_modules/@types/react/index.d.ts:1354

      +

      Defined in node_modules/@types/react/index.d.ts:1356


      Optional onCopyCapture#

      onCopyCapture? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onCopyCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1355

      +

      Defined in node_modules/@types/react/index.d.ts:1357


      Optional onCut#

      onCut? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onCut

      -

      Defined in node_modules/@types/react/index.d.ts:1356

      +

      Defined in node_modules/@types/react/index.d.ts:1358


      Optional onCutCapture#

      onCutCapture? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onCutCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1357

      +

      Defined in node_modules/@types/react/index.d.ts:1359


      Optional onDoubleClick#

      onDoubleClick? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onDoubleClick

      -

      Defined in node_modules/@types/react/index.d.ts:1456

      +

      Defined in node_modules/@types/react/index.d.ts:1458


      Optional onDoubleClickCapture#

      onDoubleClickCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onDoubleClickCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1457

      +

      Defined in node_modules/@types/react/index.d.ts:1459


      Optional onDrag#

      onDrag? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDrag

      -

      Defined in node_modules/@types/react/index.d.ts:1458

      +

      Defined in node_modules/@types/react/index.d.ts:1460


      Optional onDragCapture#

      onDragCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1459

      +

      Defined in node_modules/@types/react/index.d.ts:1461


      Optional onDragEnd#

      onDragEnd? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1460

      +

      Defined in node_modules/@types/react/index.d.ts:1462


      Optional onDragEndCapture#

      onDragEndCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1461

      +

      Defined in node_modules/@types/react/index.d.ts:1463


      Optional onDragEnter#

      onDragEnter? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragEnter

      -

      Defined in node_modules/@types/react/index.d.ts:1462

      +

      Defined in node_modules/@types/react/index.d.ts:1464


      Optional onDragEnterCapture#

      onDragEnterCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragEnterCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1463

      +

      Defined in node_modules/@types/react/index.d.ts:1465


      Optional onDragExit#

      onDragExit? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragExit

      -

      Defined in node_modules/@types/react/index.d.ts:1464

      +

      Defined in node_modules/@types/react/index.d.ts:1466


      Optional onDragExitCapture#

      onDragExitCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragExitCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1465

      +

      Defined in node_modules/@types/react/index.d.ts:1467


      Optional onDragLeave#

      onDragLeave? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragLeave

      -

      Defined in node_modules/@types/react/index.d.ts:1466

      +

      Defined in node_modules/@types/react/index.d.ts:1468


      Optional onDragLeaveCapture#

      onDragLeaveCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragLeaveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1467

      +

      Defined in node_modules/@types/react/index.d.ts:1469


      Optional onDragOver#

      onDragOver? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragOver

      -

      Defined in node_modules/@types/react/index.d.ts:1468

      +

      Defined in node_modules/@types/react/index.d.ts:1470


      Optional onDragOverCapture#

      onDragOverCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragOverCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1469

      +

      Defined in node_modules/@types/react/index.d.ts:1471


      Optional onDragStart#

      onDragStart? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragStart

      -

      Defined in node_modules/@types/react/index.d.ts:1470

      +

      Defined in node_modules/@types/react/index.d.ts:1472


      Optional onDragStartCapture#

      onDragStartCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1471

      +

      Defined in node_modules/@types/react/index.d.ts:1473


      Optional onDrop#

      onDrop? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDrop

      -

      Defined in node_modules/@types/react/index.d.ts:1472

      +

      Defined in node_modules/@types/react/index.d.ts:1474


      Optional onDropCapture#

      onDropCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDropCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1473

      +

      Defined in node_modules/@types/react/index.d.ts:1475


      Optional onDurationChange#

      onDurationChange? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onDurationChange

      -

      Defined in node_modules/@types/react/index.d.ts:1410

      +

      Defined in node_modules/@types/react/index.d.ts:1412


      Optional onDurationChangeCapture#

      onDurationChangeCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onDurationChangeCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1411

      +

      Defined in node_modules/@types/react/index.d.ts:1413


      Optional onEmptied#

      onEmptied? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEmptied

      -

      Defined in node_modules/@types/react/index.d.ts:1412

      +

      Defined in node_modules/@types/react/index.d.ts:1414


      Optional onEmptiedCapture#

      onEmptiedCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEmptiedCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1413

      +

      Defined in node_modules/@types/react/index.d.ts:1415


      Optional onEncrypted#

      onEncrypted? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEncrypted

      -

      Defined in node_modules/@types/react/index.d.ts:1414

      +

      Defined in node_modules/@types/react/index.d.ts:1416


      Optional onEncryptedCapture#

      onEncryptedCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEncryptedCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1415

      +

      Defined in node_modules/@types/react/index.d.ts:1417


      Optional onEnded#

      onEnded? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEnded

      -

      Defined in node_modules/@types/react/index.d.ts:1416

      +

      Defined in node_modules/@types/react/index.d.ts:1418


      Optional onEndedCapture#

      onEndedCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEndedCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1417

      +

      Defined in node_modules/@types/react/index.d.ts:1419


      Optional onError#

      onError? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onError

      -

      Defined in node_modules/@types/react/index.d.ts:1392

      +

      Defined in node_modules/@types/react/index.d.ts:1394


      Optional onErrorCapture#

      onErrorCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onErrorCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1393

      +

      Defined in node_modules/@types/react/index.d.ts:1395


      Optional onFocus#

      onFocus? : FocusEventHandler‹any›

      Inherited from PageLayoutProps.onFocus

      -

      Defined in node_modules/@types/react/index.d.ts:1370

      +

      Defined in node_modules/@types/react/index.d.ts:1372


      Optional onFocusCapture#

      onFocusCapture? : FocusEventHandler‹any›

      Inherited from PageLayoutProps.onFocusCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1371

      +

      Defined in node_modules/@types/react/index.d.ts:1373


      Optional onGotPointerCapture#

      onGotPointerCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onGotPointerCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1518

      +

      Defined in node_modules/@types/react/index.d.ts:1520


      Optional onGotPointerCaptureCapture#

      onGotPointerCaptureCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onGotPointerCaptureCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1519

      +

      Defined in node_modules/@types/react/index.d.ts:1521


      Optional onInput#

      onInput? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onInput

      -

      Defined in node_modules/@types/react/index.d.ts:1380

      +

      Defined in node_modules/@types/react/index.d.ts:1382


      Optional onInputCapture#

      onInputCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onInputCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1381

      +

      Defined in node_modules/@types/react/index.d.ts:1383


      Optional onInvalid#

      onInvalid? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onInvalid

      -

      Defined in node_modules/@types/react/index.d.ts:1386

      +

      Defined in node_modules/@types/react/index.d.ts:1388


      Optional onInvalidCapture#

      onInvalidCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onInvalidCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1387

      +

      Defined in node_modules/@types/react/index.d.ts:1389


      Optional onKeyDown#

      onKeyDown? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyDown

      -

      Defined in node_modules/@types/react/index.d.ts:1396

      +

      Defined in node_modules/@types/react/index.d.ts:1398


      Optional onKeyDownCapture#

      onKeyDownCapture? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyDownCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1397

      +

      Defined in node_modules/@types/react/index.d.ts:1399


      Optional onKeyPress#

      onKeyPress? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyPress

      -

      Defined in node_modules/@types/react/index.d.ts:1398

      +

      Defined in node_modules/@types/react/index.d.ts:1400


      Optional onKeyPressCapture#

      onKeyPressCapture? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyPressCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1399

      +

      Defined in node_modules/@types/react/index.d.ts:1401


      Optional onKeyUp#

      onKeyUp? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyUp

      -

      Defined in node_modules/@types/react/index.d.ts:1400

      +

      Defined in node_modules/@types/react/index.d.ts:1402


      Optional onKeyUpCapture#

      onKeyUpCapture? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyUpCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1401

      +

      Defined in node_modules/@types/react/index.d.ts:1403


      Optional onLoad#

      onLoad? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoad

      -

      Defined in node_modules/@types/react/index.d.ts:1390

      +

      Defined in node_modules/@types/react/index.d.ts:1392


      Optional onLoadCapture#

      onLoadCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1391

      +

      Defined in node_modules/@types/react/index.d.ts:1393


      Optional onLoadStart#

      onLoadStart? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadStart

      -

      Defined in node_modules/@types/react/index.d.ts:1422

      +

      Defined in node_modules/@types/react/index.d.ts:1424


      Optional onLoadStartCapture#

      onLoadStartCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1423

      +

      Defined in node_modules/@types/react/index.d.ts:1425


      Optional onLoadedData#

      onLoadedData? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadedData

      -

      Defined in node_modules/@types/react/index.d.ts:1418

      +

      Defined in node_modules/@types/react/index.d.ts:1420


      Optional onLoadedDataCapture#

      onLoadedDataCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadedDataCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1419

      +

      Defined in node_modules/@types/react/index.d.ts:1421


      Optional onLoadedMetadata#

      onLoadedMetadata? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadedMetadata

      -

      Defined in node_modules/@types/react/index.d.ts:1420

      +

      Defined in node_modules/@types/react/index.d.ts:1422


      Optional onLoadedMetadataCapture#

      onLoadedMetadataCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadedMetadataCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1421

      +

      Defined in node_modules/@types/react/index.d.ts:1423


      Optional onLostPointerCapture#

      onLostPointerCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onLostPointerCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1520

      +

      Defined in node_modules/@types/react/index.d.ts:1522


      Optional onLostPointerCaptureCapture#

      onLostPointerCaptureCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onLostPointerCaptureCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1521

      +

      Defined in node_modules/@types/react/index.d.ts:1523


      Optional onMouseDown#

      onMouseDown? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseDown

      -

      Defined in node_modules/@types/react/index.d.ts:1474

      +

      Defined in node_modules/@types/react/index.d.ts:1476


      Optional onMouseDownCapture#

      onMouseDownCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseDownCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1475

      +

      Defined in node_modules/@types/react/index.d.ts:1477


      Optional onMouseEnter#

      onMouseEnter? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseEnter

      -

      Defined in node_modules/@types/react/index.d.ts:1476

      +

      Defined in node_modules/@types/react/index.d.ts:1478


      Optional onMouseLeave#

      onMouseLeave? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseLeave

      -

      Defined in node_modules/@types/react/index.d.ts:1477

      +

      Defined in node_modules/@types/react/index.d.ts:1479


      Optional onMouseMove#

      onMouseMove? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseMove

      -

      Defined in node_modules/@types/react/index.d.ts:1478

      +

      Defined in node_modules/@types/react/index.d.ts:1480


      Optional onMouseMoveCapture#

      onMouseMoveCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseMoveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1479

      +

      Defined in node_modules/@types/react/index.d.ts:1481


      Optional onMouseOut#

      onMouseOut? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseOut

      -

      Defined in node_modules/@types/react/index.d.ts:1480

      +

      Defined in node_modules/@types/react/index.d.ts:1482


      Optional onMouseOutCapture#

      onMouseOutCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseOutCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1481

      +

      Defined in node_modules/@types/react/index.d.ts:1483


      Optional onMouseOver#

      onMouseOver? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseOver

      -

      Defined in node_modules/@types/react/index.d.ts:1482

      +

      Defined in node_modules/@types/react/index.d.ts:1484


      Optional onMouseOverCapture#

      onMouseOverCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseOverCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1483

      +

      Defined in node_modules/@types/react/index.d.ts:1485


      Optional onMouseUp#

      onMouseUp? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseUp

      -

      Defined in node_modules/@types/react/index.d.ts:1484

      +

      Defined in node_modules/@types/react/index.d.ts:1486


      Optional onMouseUpCapture#

      onMouseUpCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseUpCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1485

      +

      Defined in node_modules/@types/react/index.d.ts:1487


      Optional onPaste#

      onPaste? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onPaste

      -

      Defined in node_modules/@types/react/index.d.ts:1358

      +

      Defined in node_modules/@types/react/index.d.ts:1360


      Optional onPasteCapture#

      onPasteCapture? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onPasteCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1359

      +

      Defined in node_modules/@types/react/index.d.ts:1361


      Optional onPause#

      onPause? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPause

      -

      Defined in node_modules/@types/react/index.d.ts:1424

      +

      Defined in node_modules/@types/react/index.d.ts:1426


      Optional onPauseCapture#

      onPauseCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPauseCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1425

      +

      Defined in node_modules/@types/react/index.d.ts:1427


      Optional onPlay#

      onPlay? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPlay

      -

      Defined in node_modules/@types/react/index.d.ts:1426

      +

      Defined in node_modules/@types/react/index.d.ts:1428


      Optional onPlayCapture#

      onPlayCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPlayCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1427

      +

      Defined in node_modules/@types/react/index.d.ts:1429


      Optional onPlaying#

      onPlaying? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPlaying

      -

      Defined in node_modules/@types/react/index.d.ts:1428

      +

      Defined in node_modules/@types/react/index.d.ts:1430


      Optional onPlayingCapture#

      onPlayingCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPlayingCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1429

      +

      Defined in node_modules/@types/react/index.d.ts:1431


      Optional onPointerCancel#

      onPointerCancel? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerCancel

      -

      Defined in node_modules/@types/react/index.d.ts:1508

      +

      Defined in node_modules/@types/react/index.d.ts:1510


      Optional onPointerCancelCapture#

      onPointerCancelCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerCancelCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1509

      +

      Defined in node_modules/@types/react/index.d.ts:1511


      Optional onPointerDown#

      onPointerDown? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerDown

      -

      Defined in node_modules/@types/react/index.d.ts:1502

      +

      Defined in node_modules/@types/react/index.d.ts:1504


      Optional onPointerDownCapture#

      onPointerDownCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerDownCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1503

      +

      Defined in node_modules/@types/react/index.d.ts:1505


      Optional onPointerEnter#

      onPointerEnter? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerEnter

      -

      Defined in node_modules/@types/react/index.d.ts:1510

      +

      Defined in node_modules/@types/react/index.d.ts:1512


      Optional onPointerEnterCapture#

      onPointerEnterCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerEnterCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1511

      +

      Defined in node_modules/@types/react/index.d.ts:1513


      Optional onPointerLeave#

      onPointerLeave? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerLeave

      -

      Defined in node_modules/@types/react/index.d.ts:1512

      +

      Defined in node_modules/@types/react/index.d.ts:1514


      Optional onPointerLeaveCapture#

      onPointerLeaveCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerLeaveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1513

      +

      Defined in node_modules/@types/react/index.d.ts:1515


      Optional onPointerMove#

      onPointerMove? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerMove

      -

      Defined in node_modules/@types/react/index.d.ts:1504

      +

      Defined in node_modules/@types/react/index.d.ts:1506


      Optional onPointerMoveCapture#

      onPointerMoveCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerMoveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1505

      +

      Defined in node_modules/@types/react/index.d.ts:1507


      Optional onPointerOut#

      onPointerOut? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerOut

      -

      Defined in node_modules/@types/react/index.d.ts:1516

      +

      Defined in node_modules/@types/react/index.d.ts:1518


      Optional onPointerOutCapture#

      onPointerOutCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerOutCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1517

      +

      Defined in node_modules/@types/react/index.d.ts:1519


      Optional onPointerOver#

      onPointerOver? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerOver

      -

      Defined in node_modules/@types/react/index.d.ts:1514

      +

      Defined in node_modules/@types/react/index.d.ts:1516


      Optional onPointerOverCapture#

      onPointerOverCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerOverCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1515

      +

      Defined in node_modules/@types/react/index.d.ts:1517


      Optional onPointerUp#

      onPointerUp? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerUp

      -

      Defined in node_modules/@types/react/index.d.ts:1506

      +

      Defined in node_modules/@types/react/index.d.ts:1508


      Optional onPointerUpCapture#

      onPointerUpCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerUpCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1507

      +

      Defined in node_modules/@types/react/index.d.ts:1509


      Optional onProgress#

      onProgress? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onProgress

      -

      Defined in node_modules/@types/react/index.d.ts:1430

      +

      Defined in node_modules/@types/react/index.d.ts:1432


      Optional onProgressCapture#

      onProgressCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onProgressCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1431

      +

      Defined in node_modules/@types/react/index.d.ts:1433


      Optional onRateChange#

      onRateChange? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onRateChange

      -

      Defined in node_modules/@types/react/index.d.ts:1432

      +

      Defined in node_modules/@types/react/index.d.ts:1434


      Optional onRateChangeCapture#

      onRateChangeCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onRateChangeCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1433

      +

      Defined in node_modules/@types/react/index.d.ts:1435


      Optional onReset#

      onReset? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onReset

      -

      Defined in node_modules/@types/react/index.d.ts:1382

      +

      Defined in node_modules/@types/react/index.d.ts:1384


      Optional onResetCapture#

      onResetCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onResetCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1383

      +

      Defined in node_modules/@types/react/index.d.ts:1385


      Optional onScroll#

      onScroll? : UIEventHandler‹any›

      Inherited from PageLayoutProps.onScroll

      -

      Defined in node_modules/@types/react/index.d.ts:1524

      +

      Defined in node_modules/@types/react/index.d.ts:1526


      Optional onScrollCapture#

      onScrollCapture? : UIEventHandler‹any›

      Inherited from PageLayoutProps.onScrollCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1525

      +

      Defined in node_modules/@types/react/index.d.ts:1527


      Optional onSeeked#

      onSeeked? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSeeked

      -

      Defined in node_modules/@types/react/index.d.ts:1434

      +

      Defined in node_modules/@types/react/index.d.ts:1436


      Optional onSeekedCapture#

      onSeekedCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSeekedCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1435

      +

      Defined in node_modules/@types/react/index.d.ts:1437


      Optional onSeeking#

      onSeeking? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSeeking

      -

      Defined in node_modules/@types/react/index.d.ts:1436

      +

      Defined in node_modules/@types/react/index.d.ts:1438


      Optional onSeekingCapture#

      onSeekingCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSeekingCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1437

      +

      Defined in node_modules/@types/react/index.d.ts:1439


      Optional onSelect#

      onSelect? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSelect

      -

      Defined in node_modules/@types/react/index.d.ts:1488

      +

      Defined in node_modules/@types/react/index.d.ts:1490


      Optional onSelectCapture#

      onSelectCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSelectCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1489

      +

      Defined in node_modules/@types/react/index.d.ts:1491


      Optional onStalled#

      onStalled? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onStalled

      -

      Defined in node_modules/@types/react/index.d.ts:1438

      +

      Defined in node_modules/@types/react/index.d.ts:1440


      Optional onStalledCapture#

      onStalledCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onStalledCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1439

      +

      Defined in node_modules/@types/react/index.d.ts:1441


      Optional onSubmit#

      onSubmit? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onSubmit

      -

      Defined in node_modules/@types/react/index.d.ts:1384

      +

      Defined in node_modules/@types/react/index.d.ts:1386


      Optional onSubmitCapture#

      onSubmitCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onSubmitCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1385

      +

      Defined in node_modules/@types/react/index.d.ts:1387


      Optional onSuspend#

      onSuspend? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSuspend

      -

      Defined in node_modules/@types/react/index.d.ts:1440

      +

      Defined in node_modules/@types/react/index.d.ts:1442


      Optional onSuspendCapture#

      onSuspendCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSuspendCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1441

      +

      Defined in node_modules/@types/react/index.d.ts:1443


      Optional onTimeUpdate#

      onTimeUpdate? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onTimeUpdate

      -

      Defined in node_modules/@types/react/index.d.ts:1442

      +

      Defined in node_modules/@types/react/index.d.ts:1444


      Optional onTimeUpdateCapture#

      onTimeUpdateCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onTimeUpdateCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1443

      +

      Defined in node_modules/@types/react/index.d.ts:1445


      Optional onTouchCancel#

      onTouchCancel? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchCancel

      -

      Defined in node_modules/@types/react/index.d.ts:1492

      +

      Defined in node_modules/@types/react/index.d.ts:1494


      Optional onTouchCancelCapture#

      onTouchCancelCapture? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchCancelCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1493

      +

      Defined in node_modules/@types/react/index.d.ts:1495


      Optional onTouchEnd#

      onTouchEnd? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1494

      +

      Defined in node_modules/@types/react/index.d.ts:1496


      Optional onTouchEndCapture#

      onTouchEndCapture? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1495

      +

      Defined in node_modules/@types/react/index.d.ts:1497


      Optional onTouchMove#

      onTouchMove? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchMove

      -

      Defined in node_modules/@types/react/index.d.ts:1496

      +

      Defined in node_modules/@types/react/index.d.ts:1498


      Optional onTouchMoveCapture#

      onTouchMoveCapture? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchMoveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1497

      +

      Defined in node_modules/@types/react/index.d.ts:1499


      Optional onTouchStart#

      onTouchStart? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchStart

      -

      Defined in node_modules/@types/react/index.d.ts:1498

      +

      Defined in node_modules/@types/react/index.d.ts:1500


      Optional onTouchStartCapture#

      onTouchStartCapture? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1499

      +

      Defined in node_modules/@types/react/index.d.ts:1501


      Optional onTransitionEnd#

      onTransitionEnd? : TransitionEventHandler‹any›

      Inherited from PageLayoutProps.onTransitionEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1540

      +

      Defined in node_modules/@types/react/index.d.ts:1542


      Optional onTransitionEndCapture#

      onTransitionEndCapture? : TransitionEventHandler‹any›

      Inherited from PageLayoutProps.onTransitionEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1541

      +

      Defined in node_modules/@types/react/index.d.ts:1543


      Optional onVolumeChange#

      onVolumeChange? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onVolumeChange

      -

      Defined in node_modules/@types/react/index.d.ts:1444

      +

      Defined in node_modules/@types/react/index.d.ts:1446


      Optional onVolumeChangeCapture#

      onVolumeChangeCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onVolumeChangeCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1445

      +

      Defined in node_modules/@types/react/index.d.ts:1447


      Optional onWaiting#

      onWaiting? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onWaiting

      -

      Defined in node_modules/@types/react/index.d.ts:1446

      +

      Defined in node_modules/@types/react/index.d.ts:1448


      Optional onWaitingCapture#

      onWaitingCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onWaitingCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1447

      +

      Defined in node_modules/@types/react/index.d.ts:1449


      Optional onWheel#

      onWheel? : WheelEventHandler‹any›

      Inherited from PageLayoutProps.onWheel

      -

      Defined in node_modules/@types/react/index.d.ts:1528

      +

      Defined in node_modules/@types/react/index.d.ts:1530


      Optional onWheelCapture#

      onWheelCapture? : WheelEventHandler‹any›

      Inherited from PageLayoutProps.onWheelCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1529

      +

      Defined in node_modules/@types/react/index.d.ts:1531


      Optional placeholder#

      placeholder? : string

      Inherited from ButtonProps.placeholder

      -

      Defined in node_modules/@types/react/index.d.ts:1760

      +

      Defined in node_modules/@types/react/index.d.ts:1762


      Optional prefix#

      prefix? : string

      Inherited from ButtonProps.prefix

      -

      Defined in node_modules/@types/react/index.d.ts:1778

      +

      Defined in node_modules/@types/react/index.d.ts:1780


      Optional property#

      property? : string

      Inherited from ButtonProps.property

      -

      Defined in node_modules/@types/react/index.d.ts:1779

      +

      Defined in node_modules/@types/react/index.d.ts:1781


      Optional radioGroup#

      radioGroup? : string

      Inherited from ButtonProps.radioGroup

      -

      Defined in node_modules/@types/react/index.d.ts:1769

      +

      Defined in node_modules/@types/react/index.d.ts:1771


      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

      Inherited from ButtonProps.resource

      -

      Defined in node_modules/@types/react/index.d.ts:1780

      +

      Defined in node_modules/@types/react/index.d.ts:1782


      Optional results#

      results? : number

      Inherited from ButtonProps.results

      -

      Defined in node_modules/@types/react/index.d.ts:1794

      +

      Defined in node_modules/@types/react/index.d.ts:1796


      Optional role#

      role? : string

      Inherited from ButtonProps.role

      -

      Defined in node_modules/@types/react/index.d.ts:1772

      +

      Defined in node_modules/@types/react/index.d.ts:1774


      Optional security#

      security? : string

      Inherited from ButtonProps.security

      -

      Defined in node_modules/@types/react/index.d.ts:1795

      +

      Defined in node_modules/@types/react/index.d.ts:1797


      Optional slot#

      slot? : string

      Inherited from ButtonProps.slot

      -

      Defined in node_modules/@types/react/index.d.ts:1761

      +

      Defined in node_modules/@types/react/index.d.ts:1763


      Optional spellCheck#

      spellCheck? : Booleanish

      Inherited from ButtonProps.spellCheck

      -

      Defined in node_modules/@types/react/index.d.ts:1762

      +

      Defined in node_modules/@types/react/index.d.ts:1764


      Optional style#

      style? : CSSProperties

      Inherited from ButtonProps.style

      -

      Defined in node_modules/@types/react/index.d.ts:1763

      +

      Defined in node_modules/@types/react/index.d.ts:1765


      Optional suppressContentEditableWarning#

      suppressContentEditableWarning? : boolean

      Inherited from ButtonProps.suppressContentEditableWarning

      -

      Defined in node_modules/@types/react/index.d.ts:1747

      +

      Defined in node_modules/@types/react/index.d.ts:1749


      Optional suppressHydrationWarning#

      suppressHydrationWarning? : boolean

      Inherited from ButtonProps.suppressHydrationWarning

      -

      Defined in node_modules/@types/react/index.d.ts:1748

      +

      Defined in node_modules/@types/react/index.d.ts:1750


      Optional tabIndex#

      tabIndex? : number

      Inherited from ButtonProps.tabIndex

      -

      Defined in node_modules/@types/react/index.d.ts:1764

      +

      Defined in node_modules/@types/react/index.d.ts:1766


      Optional title#

      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"

      Inherited from ButtonProps.translate

      -

      Defined in node_modules/@types/react/index.d.ts:1766

      +

      Defined in node_modules/@types/react/index.d.ts:1768


      Optional typeof#

      typeof? : string

      Inherited from ButtonProps.typeof

      -

      Defined in node_modules/@types/react/index.d.ts:1781

      +

      Defined in node_modules/@types/react/index.d.ts:1783


      Optional unselectable#

      unselectable? : "on" | "off"

      Inherited from ButtonProps.unselectable

      -

      Defined in node_modules/@types/react/index.d.ts:1796

      +

      Defined in node_modules/@types/react/index.d.ts:1798


      Optional vocab#

      vocab? : string

      Inherited from ButtonProps.vocab

      -

      Defined in node_modules/@types/react/index.d.ts:1782

      +

      Defined in node_modules/@types/react/index.d.ts:1784

      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 2884bf5f83..3f0c1f6fd3 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -2938,214 +2938,214 @@

      Optional about#

      about? : string

      Inherited from ButtonProps.about

      -

      Defined in node_modules/@types/react/index.d.ts:1775

      +

      Defined in node_modules/@types/react/index.d.ts:1777


      Optional accessKey#

      accessKey? : string

      Inherited from ButtonProps.accessKey

      -

      Defined in node_modules/@types/react/index.d.ts:1751

      +

      Defined in node_modules/@types/react/index.d.ts:1753


      Optional aria-activedescendant#

      aria-activedescendant? : string

      Inherited from ButtonProps.aria-activedescendant

      -

      Defined in node_modules/@types/react/index.d.ts:1558

      +

      Defined in node_modules/@types/react/index.d.ts:1560

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1562

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1567

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1569

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1574

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1579

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1584

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1589

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1594

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1596

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1601

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1606

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1611

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1616

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1621

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1623

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1628

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1633

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1635

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1640

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1645

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1647

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1652

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1657

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1659

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1661

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1663

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1665

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1667

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1669

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1675

      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.

      @@ -3153,160 +3153,160 @@ between DOM elements where the DOM hierarchy cannot be used to represent the rel

      Optional aria-placeholder#

      aria-placeholder? : string

      Inherited from ButtonProps.aria-placeholder

      -

      Defined in node_modules/@types/react/index.d.ts:1678

      +

      Defined in node_modules/@types/react/index.d.ts:1680

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1685

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1690

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1695

      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"

      +

      aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

      Inherited from ButtonProps.aria-relevant

      -

      Defined in node_modules/@types/react/index.d.ts:1698

      +

      Defined in node_modules/@types/react/index.d.ts:1700

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1702

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1704

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1709

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1714

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1719

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1724

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1729

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1731

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1733

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1735

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1740

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1742

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1787


      Optional autoCorrect#

      autoCorrect? : string

      Inherited from ButtonProps.autoCorrect

      -

      Defined in node_modules/@types/react/index.d.ts:1786

      +

      Defined in node_modules/@types/react/index.d.ts:1788


      Optional autoSave#

      autoSave? : string

      Inherited from ButtonProps.autoSave

      -

      Defined in node_modules/@types/react/index.d.ts:1787

      +

      Defined in node_modules/@types/react/index.d.ts:1789


      Optional children#

      children? : ReactNode

      Inherited from PageLayoutProps.children

      -

      Defined in node_modules/@types/react/index.d.ts:1348

      +

      Defined in node_modules/@types/react/index.d.ts:1350


      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

      Inherited from ButtonProps.color

      -

      Defined in node_modules/@types/react/index.d.ts:1788

      +

      Defined in node_modules/@types/react/index.d.ts:1790


      Optional contentEditable#

      contentEditable? : Booleanish | "inherit"

      Inherited from ButtonProps.contentEditable

      -

      Defined in node_modules/@types/react/index.d.ts:1753

      +

      Defined in node_modules/@types/react/index.d.ts:1755


      Optional contextMenu#

      contextMenu? : string

      Inherited from ButtonProps.contextMenu

      -

      Defined in node_modules/@types/react/index.d.ts:1754

      +

      Defined in node_modules/@types/react/index.d.ts:1756


      Optional dangerouslySetInnerHTML#

      dangerouslySetInnerHTML? : object

      Inherited from PageLayoutProps.dangerouslySetInnerHTML

      -

      Defined in node_modules/@types/react/index.d.ts:1349

      +

      Defined in node_modules/@types/react/index.d.ts:1351

      Type declaration:

      • __html: string
      • @@ -3315,993 +3315,993 @@ A hint could be a sample value or a brief description of the expected format.

        Optional datatype#

        datatype? : string

        Inherited from ButtonProps.datatype

        -

        Defined in node_modules/@types/react/index.d.ts:1776

        +

        Defined in node_modules/@types/react/index.d.ts:1778


        Optional defaultChecked#

        defaultChecked? : boolean

        Inherited from ButtonProps.defaultChecked

        -

        Defined in node_modules/@types/react/index.d.ts:1745

        +

        Defined in node_modules/@types/react/index.d.ts:1747


        Optional defaultValue#

        -

        defaultValue? : string | number | string[]

        +

        defaultValue? : string | number | ReadonlyArray‹string›

        Inherited from ButtonProps.defaultValue

        -

        Defined in node_modules/@types/react/index.d.ts:1746

        +

        Defined in node_modules/@types/react/index.d.ts:1748


        Optional dir#

        dir? : string

        Inherited from ButtonProps.dir

        -

        Defined in node_modules/@types/react/index.d.ts:1755

        +

        Defined in node_modules/@types/react/index.d.ts:1757


        Optional draggable#

        draggable? : Booleanish

        Inherited from ButtonProps.draggable

        -

        Defined in node_modules/@types/react/index.d.ts:1756

        +

        Defined in node_modules/@types/react/index.d.ts:1758


        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

        Inherited from ButtonProps.id

        -

        Defined in node_modules/@types/react/index.d.ts:1758

        +

        Defined in node_modules/@types/react/index.d.ts:1760


        Optional inlist#

        inlist? : any

        Inherited from ButtonProps.inlist

        -

        Defined in node_modules/@types/react/index.d.ts:1777

        +

        Defined in node_modules/@types/react/index.d.ts:1779


        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

        +

        Defined in node_modules/@types/react/index.d.ts:1805

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1810

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1794


        Optional itemProp#

        itemProp? : string

        Inherited from ButtonProps.itemProp

        -

        Defined in node_modules/@types/react/index.d.ts:1789

        +

        Defined in node_modules/@types/react/index.d.ts:1791


        Optional itemRef#

        itemRef? : string

        Inherited from ButtonProps.itemRef

        -

        Defined in node_modules/@types/react/index.d.ts:1793

        +

        Defined in node_modules/@types/react/index.d.ts:1795


        Optional itemScope#

        itemScope? : boolean

        Inherited from ButtonProps.itemScope

        -

        Defined in node_modules/@types/react/index.d.ts:1790

        +

        Defined in node_modules/@types/react/index.d.ts:1792


        Optional itemType#

        itemType? : string

        Inherited from ButtonProps.itemType

        -

        Defined in node_modules/@types/react/index.d.ts:1791

        +

        Defined in node_modules/@types/react/index.d.ts:1793


        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

        Inherited from ButtonProps.lang

        -

        Defined in node_modules/@types/react/index.d.ts:1759

        +

        Defined in node_modules/@types/react/index.d.ts:1761


        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›

        Inherited from PageLayoutProps.onAbort

        -

        Defined in node_modules/@types/react/index.d.ts:1404

        +

        Defined in node_modules/@types/react/index.d.ts:1406


        Optional onAbortCapture#

        onAbortCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onAbortCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1405

        +

        Defined in node_modules/@types/react/index.d.ts:1407


        Optional onAnimationEnd#

        onAnimationEnd? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1534

        +

        Defined in node_modules/@types/react/index.d.ts:1536


        Optional onAnimationEndCapture#

        onAnimationEndCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1535

        +

        Defined in node_modules/@types/react/index.d.ts:1537


        Optional onAnimationIteration#

        onAnimationIteration? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationIteration

        -

        Defined in node_modules/@types/react/index.d.ts:1536

        +

        Defined in node_modules/@types/react/index.d.ts:1538


        Optional onAnimationIterationCapture#

        onAnimationIterationCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationIterationCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1537

        +

        Defined in node_modules/@types/react/index.d.ts:1539


        Optional onAnimationStart#

        onAnimationStart? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationStart

        -

        Defined in node_modules/@types/react/index.d.ts:1532

        +

        Defined in node_modules/@types/react/index.d.ts:1534


        Optional onAnimationStartCapture#

        onAnimationStartCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1533

        +

        Defined in node_modules/@types/react/index.d.ts:1535


        Optional onAuxClick#

        onAuxClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onAuxClick

        -

        Defined in node_modules/@types/react/index.d.ts:1450

        +

        Defined in node_modules/@types/react/index.d.ts:1452


        Optional onAuxClickCapture#

        onAuxClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onAuxClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1451

        +

        Defined in node_modules/@types/react/index.d.ts:1453


        Optional onBeforeInput#

        onBeforeInput? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onBeforeInput

        -

        Defined in node_modules/@types/react/index.d.ts:1378

        +

        Defined in node_modules/@types/react/index.d.ts:1380


        Optional onBeforeInputCapture#

        onBeforeInputCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onBeforeInputCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1379

        +

        Defined in node_modules/@types/react/index.d.ts:1381


        Optional onBlur#

        onBlur? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onBlur

        -

        Defined in node_modules/@types/react/index.d.ts:1372

        +

        Defined in node_modules/@types/react/index.d.ts:1374


        Optional onBlurCapture#

        onBlurCapture? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onBlurCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1373

        +

        Defined in node_modules/@types/react/index.d.ts:1375


        Optional onCanPlay#

        onCanPlay? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlay

        -

        Defined in node_modules/@types/react/index.d.ts:1406

        +

        Defined in node_modules/@types/react/index.d.ts:1408


        Optional onCanPlayCapture#

        onCanPlayCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1407

        +

        Defined in node_modules/@types/react/index.d.ts:1409


        Optional onCanPlayThrough#

        onCanPlayThrough? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayThrough

        -

        Defined in node_modules/@types/react/index.d.ts:1408

        +

        Defined in node_modules/@types/react/index.d.ts:1410


        Optional onCanPlayThroughCapture#

        onCanPlayThroughCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayThroughCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1409

        +

        Defined in node_modules/@types/react/index.d.ts:1411


        Optional onChange#

        onChange? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onChange

        -

        Defined in node_modules/@types/react/index.d.ts:1376

        +

        Defined in node_modules/@types/react/index.d.ts:1378


        Optional onChangeCapture#

        onChangeCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1377

        +

        Defined in node_modules/@types/react/index.d.ts:1379


        Optional onClick#

        onClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onClick

        -

        Defined in node_modules/@types/react/index.d.ts:1452

        +

        Defined in node_modules/@types/react/index.d.ts:1454


        Optional onClickCapture#

        onClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1453

        +

        Defined in node_modules/@types/react/index.d.ts:1455


        Optional onCompositionEnd#

        onCompositionEnd? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1362

        +

        Defined in node_modules/@types/react/index.d.ts:1364


        Optional onCompositionEndCapture#

        onCompositionEndCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1363

        +

        Defined in node_modules/@types/react/index.d.ts:1365


        Optional onCompositionStart#

        onCompositionStart? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionStart

        -

        Defined in node_modules/@types/react/index.d.ts:1364

        +

        Defined in node_modules/@types/react/index.d.ts:1366


        Optional onCompositionStartCapture#

        onCompositionStartCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1365

        +

        Defined in node_modules/@types/react/index.d.ts:1367


        Optional onCompositionUpdate#

        onCompositionUpdate? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionUpdate

        -

        Defined in node_modules/@types/react/index.d.ts:1366

        +

        Defined in node_modules/@types/react/index.d.ts:1368


        Optional onCompositionUpdateCapture#

        onCompositionUpdateCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionUpdateCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1367

        +

        Defined in node_modules/@types/react/index.d.ts:1369


        Optional onContextMenu#

        onContextMenu? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onContextMenu

        -

        Defined in node_modules/@types/react/index.d.ts:1454

        +

        Defined in node_modules/@types/react/index.d.ts:1456


        Optional onContextMenuCapture#

        onContextMenuCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onContextMenuCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1455

        +

        Defined in node_modules/@types/react/index.d.ts:1457


        Optional onCopy#

        onCopy? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCopy

        -

        Defined in node_modules/@types/react/index.d.ts:1354

        +

        Defined in node_modules/@types/react/index.d.ts:1356


        Optional onCopyCapture#

        onCopyCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCopyCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1355

        +

        Defined in node_modules/@types/react/index.d.ts:1357


        Optional onCut#

        onCut? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCut

        -

        Defined in node_modules/@types/react/index.d.ts:1356

        +

        Defined in node_modules/@types/react/index.d.ts:1358


        Optional onCutCapture#

        onCutCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1357

        +

        Defined in node_modules/@types/react/index.d.ts:1359


        Optional onDoubleClick#

        onDoubleClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onDoubleClick

        -

        Defined in node_modules/@types/react/index.d.ts:1456

        +

        Defined in node_modules/@types/react/index.d.ts:1458


        Optional onDoubleClickCapture#

        onDoubleClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onDoubleClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1457

        +

        Defined in node_modules/@types/react/index.d.ts:1459


        Optional onDrag#

        onDrag? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDrag

        -

        Defined in node_modules/@types/react/index.d.ts:1458

        +

        Defined in node_modules/@types/react/index.d.ts:1460


        Optional onDragCapture#

        onDragCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1459

        +

        Defined in node_modules/@types/react/index.d.ts:1461


        Optional onDragEnd#

        onDragEnd? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1460

        +

        Defined in node_modules/@types/react/index.d.ts:1462


        Optional onDragEndCapture#

        onDragEndCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1461

        +

        Defined in node_modules/@types/react/index.d.ts:1463


        Optional onDragEnter#

        onDragEnter? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1462

        +

        Defined in node_modules/@types/react/index.d.ts:1464


        Optional onDragEnterCapture#

        onDragEnterCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnterCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1463

        +

        Defined in node_modules/@types/react/index.d.ts:1465


        Optional onDragExit#

        onDragExit? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragExit

        -

        Defined in node_modules/@types/react/index.d.ts:1464

        +

        Defined in node_modules/@types/react/index.d.ts:1466


        Optional onDragExitCapture#

        onDragExitCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragExitCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1465

        +

        Defined in node_modules/@types/react/index.d.ts:1467


        Optional onDragLeave#

        onDragLeave? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1466

        +

        Defined in node_modules/@types/react/index.d.ts:1468


        Optional onDragLeaveCapture#

        onDragLeaveCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragLeaveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1467

        +

        Defined in node_modules/@types/react/index.d.ts:1469


        Optional onDragOver#

        onDragOver? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragOver

        -

        Defined in node_modules/@types/react/index.d.ts:1468

        +

        Defined in node_modules/@types/react/index.d.ts:1470


        Optional onDragOverCapture#

        onDragOverCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1469

        +

        Defined in node_modules/@types/react/index.d.ts:1471


        Optional onDragStart#

        onDragStart? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragStart

        -

        Defined in node_modules/@types/react/index.d.ts:1470

        +

        Defined in node_modules/@types/react/index.d.ts:1472


        Optional onDragStartCapture#

        onDragStartCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1471

        +

        Defined in node_modules/@types/react/index.d.ts:1473


        Optional onDrop#

        onDrop? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDrop

        -

        Defined in node_modules/@types/react/index.d.ts:1472

        +

        Defined in node_modules/@types/react/index.d.ts:1474


        Optional onDropCapture#

        onDropCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDropCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1473

        +

        Defined in node_modules/@types/react/index.d.ts:1475


        Optional onDurationChange#

        onDurationChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onDurationChange

        -

        Defined in node_modules/@types/react/index.d.ts:1410

        +

        Defined in node_modules/@types/react/index.d.ts:1412


        Optional onDurationChangeCapture#

        onDurationChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onDurationChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1411

        +

        Defined in node_modules/@types/react/index.d.ts:1413


        Optional onEmptied#

        onEmptied? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEmptied

        -

        Defined in node_modules/@types/react/index.d.ts:1412

        +

        Defined in node_modules/@types/react/index.d.ts:1414


        Optional onEmptiedCapture#

        onEmptiedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEmptiedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1413

        +

        Defined in node_modules/@types/react/index.d.ts:1415


        Optional onEncrypted#

        onEncrypted? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEncrypted

        -

        Defined in node_modules/@types/react/index.d.ts:1414

        +

        Defined in node_modules/@types/react/index.d.ts:1416


        Optional onEncryptedCapture#

        onEncryptedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEncryptedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1415

        +

        Defined in node_modules/@types/react/index.d.ts:1417


        Optional onEnded#

        onEnded? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEnded

        -

        Defined in node_modules/@types/react/index.d.ts:1416

        +

        Defined in node_modules/@types/react/index.d.ts:1418


        Optional onEndedCapture#

        onEndedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEndedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1417

        +

        Defined in node_modules/@types/react/index.d.ts:1419


        Optional onError#

        onError? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onError

        -

        Defined in node_modules/@types/react/index.d.ts:1392

        +

        Defined in node_modules/@types/react/index.d.ts:1394


        Optional onErrorCapture#

        onErrorCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onErrorCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1393

        +

        Defined in node_modules/@types/react/index.d.ts:1395


        Optional onFocus#

        onFocus? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onFocus

        -

        Defined in node_modules/@types/react/index.d.ts:1370

        +

        Defined in node_modules/@types/react/index.d.ts:1372


        Optional onFocusCapture#

        onFocusCapture? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onFocusCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1371

        +

        Defined in node_modules/@types/react/index.d.ts:1373


        Optional onGotPointerCapture#

        onGotPointerCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onGotPointerCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1518

        +

        Defined in node_modules/@types/react/index.d.ts:1520


        Optional onGotPointerCaptureCapture#

        onGotPointerCaptureCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onGotPointerCaptureCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1519

        +

        Defined in node_modules/@types/react/index.d.ts:1521


        Optional onInput#

        onInput? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInput

        -

        Defined in node_modules/@types/react/index.d.ts:1380

        +

        Defined in node_modules/@types/react/index.d.ts:1382


        Optional onInputCapture#

        onInputCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInputCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1381

        +

        Defined in node_modules/@types/react/index.d.ts:1383


        Optional onInvalid#

        onInvalid? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInvalid

        -

        Defined in node_modules/@types/react/index.d.ts:1386

        +

        Defined in node_modules/@types/react/index.d.ts:1388


        Optional onInvalidCapture#

        onInvalidCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInvalidCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1387

        +

        Defined in node_modules/@types/react/index.d.ts:1389


        Optional onKeyDown#

        onKeyDown? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyDown

        -

        Defined in node_modules/@types/react/index.d.ts:1396

        +

        Defined in node_modules/@types/react/index.d.ts:1398


        Optional onKeyDownCapture#

        onKeyDownCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1397

        +

        Defined in node_modules/@types/react/index.d.ts:1399


        Optional onKeyPress#

        onKeyPress? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyPress

        -

        Defined in node_modules/@types/react/index.d.ts:1398

        +

        Defined in node_modules/@types/react/index.d.ts:1400


        Optional onKeyPressCapture#

        onKeyPressCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyPressCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1399

        +

        Defined in node_modules/@types/react/index.d.ts:1401


        Optional onKeyUp#

        onKeyUp? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyUp

        -

        Defined in node_modules/@types/react/index.d.ts:1400

        +

        Defined in node_modules/@types/react/index.d.ts:1402


        Optional onKeyUpCapture#

        onKeyUpCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1401

        +

        Defined in node_modules/@types/react/index.d.ts:1403


        Optional onLoad#

        onLoad? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoad

        -

        Defined in node_modules/@types/react/index.d.ts:1390

        +

        Defined in node_modules/@types/react/index.d.ts:1392


        Optional onLoadCapture#

        onLoadCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1391

        +

        Defined in node_modules/@types/react/index.d.ts:1393


        Optional onLoadStart#

        onLoadStart? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadStart

        -

        Defined in node_modules/@types/react/index.d.ts:1422

        +

        Defined in node_modules/@types/react/index.d.ts:1424


        Optional onLoadStartCapture#

        onLoadStartCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1423

        +

        Defined in node_modules/@types/react/index.d.ts:1425


        Optional onLoadedData#

        onLoadedData? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedData

        -

        Defined in node_modules/@types/react/index.d.ts:1418

        +

        Defined in node_modules/@types/react/index.d.ts:1420


        Optional onLoadedDataCapture#

        onLoadedDataCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedDataCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1419

        +

        Defined in node_modules/@types/react/index.d.ts:1421


        Optional onLoadedMetadata#

        onLoadedMetadata? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedMetadata

        -

        Defined in node_modules/@types/react/index.d.ts:1420

        +

        Defined in node_modules/@types/react/index.d.ts:1422


        Optional onLoadedMetadataCapture#

        onLoadedMetadataCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedMetadataCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1421

        +

        Defined in node_modules/@types/react/index.d.ts:1423


        Optional onLostPointerCapture#

        onLostPointerCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onLostPointerCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1520

        +

        Defined in node_modules/@types/react/index.d.ts:1522


        Optional onLostPointerCaptureCapture#

        onLostPointerCaptureCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onLostPointerCaptureCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1521

        +

        Defined in node_modules/@types/react/index.d.ts:1523


        Optional onMouseDown#

        onMouseDown? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseDown

        -

        Defined in node_modules/@types/react/index.d.ts:1474

        +

        Defined in node_modules/@types/react/index.d.ts:1476


        Optional onMouseDownCapture#

        onMouseDownCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1475

        +

        Defined in node_modules/@types/react/index.d.ts:1477


        Optional onMouseEnter#

        onMouseEnter? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1476

        +

        Defined in node_modules/@types/react/index.d.ts:1478


        Optional onMouseLeave#

        onMouseLeave? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1477

        +

        Defined in node_modules/@types/react/index.d.ts:1479


        Optional onMouseMove#

        onMouseMove? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseMove

        -

        Defined in node_modules/@types/react/index.d.ts:1478

        +

        Defined in node_modules/@types/react/index.d.ts:1480


        Optional onMouseMoveCapture#

        onMouseMoveCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1479

        +

        Defined in node_modules/@types/react/index.d.ts:1481


        Optional onMouseOut#

        onMouseOut? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOut

        -

        Defined in node_modules/@types/react/index.d.ts:1480

        +

        Defined in node_modules/@types/react/index.d.ts:1482


        Optional onMouseOutCapture#

        onMouseOutCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1481

        +

        Defined in node_modules/@types/react/index.d.ts:1483


        Optional onMouseOver#

        onMouseOver? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOver

        -

        Defined in node_modules/@types/react/index.d.ts:1482

        +

        Defined in node_modules/@types/react/index.d.ts:1484


        Optional onMouseOverCapture#

        onMouseOverCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1483

        +

        Defined in node_modules/@types/react/index.d.ts:1485


        Optional onMouseUp#

        onMouseUp? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseUp

        -

        Defined in node_modules/@types/react/index.d.ts:1484

        +

        Defined in node_modules/@types/react/index.d.ts:1486


        Optional onMouseUpCapture#

        onMouseUpCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1485

        +

        Defined in node_modules/@types/react/index.d.ts:1487


        Optional onPaste#

        onPaste? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onPaste

        -

        Defined in node_modules/@types/react/index.d.ts:1358

        +

        Defined in node_modules/@types/react/index.d.ts:1360


        Optional onPasteCapture#

        onPasteCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onPasteCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1359

        +

        Defined in node_modules/@types/react/index.d.ts:1361


        Optional onPause#

        onPause? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPause

        -

        Defined in node_modules/@types/react/index.d.ts:1424

        +

        Defined in node_modules/@types/react/index.d.ts:1426


        Optional onPauseCapture#

        onPauseCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPauseCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1425

        +

        Defined in node_modules/@types/react/index.d.ts:1427


        Optional onPlay#

        onPlay? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlay

        -

        Defined in node_modules/@types/react/index.d.ts:1426

        +

        Defined in node_modules/@types/react/index.d.ts:1428


        Optional onPlayCapture#

        onPlayCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlayCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1427

        +

        Defined in node_modules/@types/react/index.d.ts:1429


        Optional onPlaying#

        onPlaying? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlaying

        -

        Defined in node_modules/@types/react/index.d.ts:1428

        +

        Defined in node_modules/@types/react/index.d.ts:1430


        Optional onPlayingCapture#

        onPlayingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlayingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1429

        +

        Defined in node_modules/@types/react/index.d.ts:1431


        Optional onPointerCancel#

        onPointerCancel? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerCancel

        -

        Defined in node_modules/@types/react/index.d.ts:1508

        +

        Defined in node_modules/@types/react/index.d.ts:1510


        Optional onPointerCancelCapture#

        onPointerCancelCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerCancelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1509

        +

        Defined in node_modules/@types/react/index.d.ts:1511


        Optional onPointerDown#

        onPointerDown? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerDown

        -

        Defined in node_modules/@types/react/index.d.ts:1502

        +

        Defined in node_modules/@types/react/index.d.ts:1504


        Optional onPointerDownCapture#

        onPointerDownCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1503

        +

        Defined in node_modules/@types/react/index.d.ts:1505


        Optional onPointerEnter#

        onPointerEnter? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1510

        +

        Defined in node_modules/@types/react/index.d.ts:1512


        Optional onPointerEnterCapture#

        onPointerEnterCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerEnterCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1511

        +

        Defined in node_modules/@types/react/index.d.ts:1513


        Optional onPointerLeave#

        onPointerLeave? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1512

        +

        Defined in node_modules/@types/react/index.d.ts:1514


        Optional onPointerLeaveCapture#

        onPointerLeaveCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerLeaveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1513

        +

        Defined in node_modules/@types/react/index.d.ts:1515


        Optional onPointerMove#

        onPointerMove? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerMove

        -

        Defined in node_modules/@types/react/index.d.ts:1504

        +

        Defined in node_modules/@types/react/index.d.ts:1506


        Optional onPointerMoveCapture#

        onPointerMoveCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1505

        +

        Defined in node_modules/@types/react/index.d.ts:1507


        Optional onPointerOut#

        onPointerOut? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOut

        -

        Defined in node_modules/@types/react/index.d.ts:1516

        +

        Defined in node_modules/@types/react/index.d.ts:1518


        Optional onPointerOutCapture#

        onPointerOutCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1517

        +

        Defined in node_modules/@types/react/index.d.ts:1519


        Optional onPointerOver#

        onPointerOver? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOver

        -

        Defined in node_modules/@types/react/index.d.ts:1514

        +

        Defined in node_modules/@types/react/index.d.ts:1516


        Optional onPointerOverCapture#

        onPointerOverCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1515

        +

        Defined in node_modules/@types/react/index.d.ts:1517


        Optional onPointerUp#

        onPointerUp? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerUp

        -

        Defined in node_modules/@types/react/index.d.ts:1506

        +

        Defined in node_modules/@types/react/index.d.ts:1508


        Optional onPointerUpCapture#

        onPointerUpCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1507

        +

        Defined in node_modules/@types/react/index.d.ts:1509


        Optional onProgress#

        onProgress? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onProgress

        -

        Defined in node_modules/@types/react/index.d.ts:1430

        +

        Defined in node_modules/@types/react/index.d.ts:1432


        Optional onProgressCapture#

        onProgressCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onProgressCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1431

        +

        Defined in node_modules/@types/react/index.d.ts:1433


        Optional onRateChange#

        onRateChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onRateChange

        -

        Defined in node_modules/@types/react/index.d.ts:1432

        +

        Defined in node_modules/@types/react/index.d.ts:1434


        Optional onRateChangeCapture#

        onRateChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onRateChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1433

        +

        Defined in node_modules/@types/react/index.d.ts:1435


        Optional onReset#

        onReset? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onReset

        -

        Defined in node_modules/@types/react/index.d.ts:1382

        +

        Defined in node_modules/@types/react/index.d.ts:1384


        Optional onResetCapture#

        onResetCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onResetCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1383

        +

        Defined in node_modules/@types/react/index.d.ts:1385


        Optional onScroll#

        onScroll? : UIEventHandler‹any›

        Inherited from PageLayoutProps.onScroll

        -

        Defined in node_modules/@types/react/index.d.ts:1524

        +

        Defined in node_modules/@types/react/index.d.ts:1526


        Optional onScrollCapture#

        onScrollCapture? : UIEventHandler‹any›

        Inherited from PageLayoutProps.onScrollCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1525

        +

        Defined in node_modules/@types/react/index.d.ts:1527


        Optional onSeeked#

        onSeeked? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeeked

        -

        Defined in node_modules/@types/react/index.d.ts:1434

        +

        Defined in node_modules/@types/react/index.d.ts:1436


        Optional onSeekedCapture#

        onSeekedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeekedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1435

        +

        Defined in node_modules/@types/react/index.d.ts:1437


        Optional onSeeking#

        onSeeking? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeeking

        -

        Defined in node_modules/@types/react/index.d.ts:1436

        +

        Defined in node_modules/@types/react/index.d.ts:1438


        Optional onSeekingCapture#

        onSeekingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeekingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1437

        +

        Defined in node_modules/@types/react/index.d.ts:1439


        Optional onSelect#

        onSelect? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSelect

        -

        Defined in node_modules/@types/react/index.d.ts:1488

        +

        Defined in node_modules/@types/react/index.d.ts:1490


        Optional onSelectCapture#

        onSelectCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSelectCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1489

        +

        Defined in node_modules/@types/react/index.d.ts:1491


        Optional onStalled#

        onStalled? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onStalled

        -

        Defined in node_modules/@types/react/index.d.ts:1438

        +

        Defined in node_modules/@types/react/index.d.ts:1440


        Optional onStalledCapture#

        onStalledCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onStalledCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1439

        +

        Defined in node_modules/@types/react/index.d.ts:1441


        Optional onSubmit#

        onSubmit? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onSubmit

        -

        Defined in node_modules/@types/react/index.d.ts:1384

        +

        Defined in node_modules/@types/react/index.d.ts:1386


        Optional onSubmitCapture#

        onSubmitCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onSubmitCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1385

        +

        Defined in node_modules/@types/react/index.d.ts:1387


        Optional onSuspend#

        onSuspend? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSuspend

        -

        Defined in node_modules/@types/react/index.d.ts:1440

        +

        Defined in node_modules/@types/react/index.d.ts:1442


        Optional onSuspendCapture#

        onSuspendCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSuspendCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1441

        +

        Defined in node_modules/@types/react/index.d.ts:1443


        Optional onTimeUpdate#

        onTimeUpdate? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onTimeUpdate

        -

        Defined in node_modules/@types/react/index.d.ts:1442

        +

        Defined in node_modules/@types/react/index.d.ts:1444


        Optional onTimeUpdateCapture#

        onTimeUpdateCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onTimeUpdateCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1443

        +

        Defined in node_modules/@types/react/index.d.ts:1445


        Optional onTouchCancel#

        onTouchCancel? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchCancel

        -

        Defined in node_modules/@types/react/index.d.ts:1492

        +

        Defined in node_modules/@types/react/index.d.ts:1494


        Optional onTouchCancelCapture#

        onTouchCancelCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchCancelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1493

        +

        Defined in node_modules/@types/react/index.d.ts:1495


        Optional onTouchEnd#

        onTouchEnd? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1494

        +

        Defined in node_modules/@types/react/index.d.ts:1496


        Optional onTouchEndCapture#

        onTouchEndCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1495

        +

        Defined in node_modules/@types/react/index.d.ts:1497


        Optional onTouchMove#

        onTouchMove? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchMove

        -

        Defined in node_modules/@types/react/index.d.ts:1496

        +

        Defined in node_modules/@types/react/index.d.ts:1498


        Optional onTouchMoveCapture#

        onTouchMoveCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1497

        +

        Defined in node_modules/@types/react/index.d.ts:1499


        Optional onTouchStart#

        onTouchStart? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchStart

        -

        Defined in node_modules/@types/react/index.d.ts:1498

        +

        Defined in node_modules/@types/react/index.d.ts:1500


        Optional onTouchStartCapture#

        onTouchStartCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1499

        +

        Defined in node_modules/@types/react/index.d.ts:1501


        Optional onTransitionEnd#

        onTransitionEnd? : TransitionEventHandler‹any›

        Inherited from PageLayoutProps.onTransitionEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1540

        +

        Defined in node_modules/@types/react/index.d.ts:1542


        Optional onTransitionEndCapture#

        onTransitionEndCapture? : TransitionEventHandler‹any›

        Inherited from PageLayoutProps.onTransitionEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1541

        +

        Defined in node_modules/@types/react/index.d.ts:1543


        Optional onVolumeChange#

        onVolumeChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onVolumeChange

        -

        Defined in node_modules/@types/react/index.d.ts:1444

        +

        Defined in node_modules/@types/react/index.d.ts:1446


        Optional onVolumeChangeCapture#

        onVolumeChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onVolumeChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1445

        +

        Defined in node_modules/@types/react/index.d.ts:1447


        Optional onWaiting#

        onWaiting? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onWaiting

        -

        Defined in node_modules/@types/react/index.d.ts:1446

        +

        Defined in node_modules/@types/react/index.d.ts:1448


        Optional onWaitingCapture#

        onWaitingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onWaitingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1447

        +

        Defined in node_modules/@types/react/index.d.ts:1449


        Optional onWheel#

        onWheel? : WheelEventHandler‹any›

        Inherited from PageLayoutProps.onWheel

        -

        Defined in node_modules/@types/react/index.d.ts:1528

        +

        Defined in node_modules/@types/react/index.d.ts:1530


        Optional onWheelCapture#

        onWheelCapture? : WheelEventHandler‹any›

        Inherited from PageLayoutProps.onWheelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1529

        +

        Defined in node_modules/@types/react/index.d.ts:1531


        Optional placeholder#

        placeholder? : string

        Inherited from ButtonProps.placeholder

        -

        Defined in node_modules/@types/react/index.d.ts:1760

        +

        Defined in node_modules/@types/react/index.d.ts:1762


        Optional prefix#

        prefix? : string

        Inherited from ButtonProps.prefix

        -

        Defined in node_modules/@types/react/index.d.ts:1778

        +

        Defined in node_modules/@types/react/index.d.ts:1780


        Optional property#

        property? : string

        Inherited from ButtonProps.property

        -

        Defined in node_modules/@types/react/index.d.ts:1779

        +

        Defined in node_modules/@types/react/index.d.ts:1781


        Optional radioGroup#

        radioGroup? : string

        Inherited from ButtonProps.radioGroup

        -

        Defined in node_modules/@types/react/index.d.ts:1769

        +

        Defined in node_modules/@types/react/index.d.ts:1771


        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

        Inherited from ButtonProps.resource

        -

        Defined in node_modules/@types/react/index.d.ts:1780

        +

        Defined in node_modules/@types/react/index.d.ts:1782


        Optional results#

        results? : number

        Inherited from ButtonProps.results

        -

        Defined in node_modules/@types/react/index.d.ts:1794

        +

        Defined in node_modules/@types/react/index.d.ts:1796


        Optional role#

        role? : string

        Inherited from ButtonProps.role

        -

        Defined in node_modules/@types/react/index.d.ts:1772

        +

        Defined in node_modules/@types/react/index.d.ts:1774


        Optional security#

        security? : string

        Inherited from ButtonProps.security

        -

        Defined in node_modules/@types/react/index.d.ts:1795

        +

        Defined in node_modules/@types/react/index.d.ts:1797


        Optional slot#

        slot? : string

        Inherited from ButtonProps.slot

        -

        Defined in node_modules/@types/react/index.d.ts:1761

        +

        Defined in node_modules/@types/react/index.d.ts:1763


        Optional spellCheck#

        spellCheck? : Booleanish

        Inherited from ButtonProps.spellCheck

        -

        Defined in node_modules/@types/react/index.d.ts:1762

        +

        Defined in node_modules/@types/react/index.d.ts:1764


        Optional style#

        style? : CSSProperties

        Inherited from ButtonProps.style

        -

        Defined in node_modules/@types/react/index.d.ts:1763

        +

        Defined in node_modules/@types/react/index.d.ts:1765


        Optional suppressContentEditableWarning#

        suppressContentEditableWarning? : boolean

        Inherited from ButtonProps.suppressContentEditableWarning

        -

        Defined in node_modules/@types/react/index.d.ts:1747

        +

        Defined in node_modules/@types/react/index.d.ts:1749


        Optional suppressHydrationWarning#

        suppressHydrationWarning? : boolean

        Inherited from ButtonProps.suppressHydrationWarning

        -

        Defined in node_modules/@types/react/index.d.ts:1748

        +

        Defined in node_modules/@types/react/index.d.ts:1750


        Optional tabIndex#

        tabIndex? : number

        Inherited from ButtonProps.tabIndex

        -

        Defined in node_modules/@types/react/index.d.ts:1764

        +

        Defined in node_modules/@types/react/index.d.ts:1766


        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"

        Inherited from ButtonProps.translate

        -

        Defined in node_modules/@types/react/index.d.ts:1766

        +

        Defined in node_modules/@types/react/index.d.ts:1768


        Optional typeof#

        typeof? : string

        Inherited from ButtonProps.typeof

        -

        Defined in node_modules/@types/react/index.d.ts:1781

        +

        Defined in node_modules/@types/react/index.d.ts:1783


        Optional unselectable#

        unselectable? : "on" | "off"

        Inherited from ButtonProps.unselectable

        -

        Defined in node_modules/@types/react/index.d.ts:1796

        +

        Defined in node_modules/@types/react/index.d.ts:1798


        Optional vocab#

        vocab? : string

        Inherited from ButtonProps.vocab

        -

        Defined in node_modules/@types/react/index.d.ts:1782

        +

        Defined in node_modules/@types/react/index.d.ts:1784

        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 75853d5f6d..9865c18362 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -887,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:7

        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 173c5e236a..1c46a0dbba 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -959,45 +959,45 @@

        Properties#

        Optional animation#

        animation? : AnimateName

        -

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

        +

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


        Optional className#

        className? : string | object

        -

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

        +

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


        Optional contentClass#

        contentClass? : string | object

        -

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

        +

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


        Optional onClose#

        onClose? : function

        -

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

        +

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

        Type declaration:

        ▸ (): void


        open#

        open: boolean

        -

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

        +

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


        Optional position#

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

        -

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

        +

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


        Optional size#

        size? : string

        -

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

        +

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


        title#

        title: React.ReactNode

        -

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

        +

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


        Optional toolbar#

        toolbar? : React.ReactNode

        -

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

        +

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


        Optional usePortal#

        usePortal? : boolean

        -

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

        +

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

        diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html index 57c0ae4a4c..547e10d72f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -895,11 +895,11 @@

        Properties#

        Optional className#

        className? : string

        -

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

        +

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


        Optional title#

        title? : React.ReactNode

        -

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

        +

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

        diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html index 673030d8a4..5f1a683160 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -904,11 +904,11 @@

        Properties#

        label#

        label: ReactNode

        -

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

        +

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


        options#

        options: T[]

        -

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

        +

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

        diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html index 50483e1bcd..7fe3033b53 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -3038,218 +3038,218 @@

        Optional about#

        about? : string

        Inherited from ButtonProps.about

        -

        Defined in node_modules/@types/react/index.d.ts:1775

        +

        Defined in node_modules/@types/react/index.d.ts:1777


        Optional accessKey#

        accessKey? : string

        Inherited from ButtonProps.accessKey

        -

        Defined in node_modules/@types/react/index.d.ts:1751

        +

        Defined in node_modules/@types/react/index.d.ts:1753


        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

        Inherited from ButtonProps.aria-activedescendant

        -

        Defined in node_modules/@types/react/index.d.ts:1558

        +

        Defined in node_modules/@types/react/index.d.ts:1560

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1562

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1567

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1569

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1574

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1579

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1584

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1589

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1594

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1596

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1601

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1606

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1611

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1616

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1621

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1623

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1628

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1633

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1635

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1640

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1645

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1647

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1652

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1657

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1659

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1661

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1663

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1665

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1667

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1669

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1675

        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.

        @@ -3257,164 +3257,164 @@ between DOM elements where the DOM hierarchy cannot be used to represent the rel

        Optional aria-placeholder#

        aria-placeholder? : string

        Inherited from ButtonProps.aria-placeholder

        -

        Defined in node_modules/@types/react/index.d.ts:1678

        +

        Defined in node_modules/@types/react/index.d.ts:1680

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1685

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1690

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1695

        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"

        +

        aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

        Inherited from ButtonProps.aria-relevant

        -

        Defined in node_modules/@types/react/index.d.ts:1698

        +

        Defined in node_modules/@types/react/index.d.ts:1700

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1702

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1704

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1709

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1714

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1719

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1724

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1729

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1731

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1733

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1735

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1740

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1742

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1787


        Optional autoCorrect#

        autoCorrect? : string

        Inherited from ButtonProps.autoCorrect

        -

        Defined in node_modules/@types/react/index.d.ts:1786

        +

        Defined in node_modules/@types/react/index.d.ts:1788


        Optional autoSave#

        autoSave? : string

        Inherited from ButtonProps.autoSave

        -

        Defined in node_modules/@types/react/index.d.ts:1787

        +

        Defined in node_modules/@types/react/index.d.ts:1789


        Optional big#

        big? : boolean

        -

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

        +

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


        Optional children#

        children? : ReactNode

        Inherited from PageLayoutProps.children

        -

        Defined in node_modules/@types/react/index.d.ts:1348

        +

        Defined in node_modules/@types/react/index.d.ts:1350


        Optional className#

        className? : string

        Inherited from ButtonProps.className

        -

        Defined in node_modules/@types/react/index.d.ts:1752

        +

        Defined in node_modules/@types/react/index.d.ts:1754


        Optional color#

        color? : string

        Inherited from ButtonProps.color

        -

        Defined in node_modules/@types/react/index.d.ts:1788

        +

        Defined in node_modules/@types/react/index.d.ts:1790


        Optional contentEditable#

        contentEditable? : Booleanish | "inherit"

        Inherited from ButtonProps.contentEditable

        -

        Defined in node_modules/@types/react/index.d.ts:1753

        +

        Defined in node_modules/@types/react/index.d.ts:1755


        Optional contextMenu#

        contextMenu? : string

        Inherited from ButtonProps.contextMenu

        -

        Defined in node_modules/@types/react/index.d.ts:1754

        +

        Defined in node_modules/@types/react/index.d.ts:1756


        Optional dangerouslySetInnerHTML#

        dangerouslySetInnerHTML? : object

        Inherited from PageLayoutProps.dangerouslySetInnerHTML

        -

        Defined in node_modules/@types/react/index.d.ts:1349

        +

        Defined in node_modules/@types/react/index.d.ts:1351

        Type declaration:

        • __html: string
        • @@ -3423,1037 +3423,1037 @@ A hint could be a sample value or a brief description of the expected format.

          Optional datatype#

          datatype? : string

          Inherited from ButtonProps.datatype

          -

          Defined in node_modules/@types/react/index.d.ts:1776

          +

          Defined in node_modules/@types/react/index.d.ts:1778


          Optional defaultChecked#

          defaultChecked? : boolean

          Inherited from ButtonProps.defaultChecked

          -

          Defined in node_modules/@types/react/index.d.ts:1745

          +

          Defined in node_modules/@types/react/index.d.ts:1747


          Optional defaultValue#

          -

          defaultValue? : string | number | string[]

          +

          defaultValue? : string | number | ReadonlyArray‹string›

          Inherited from ButtonProps.defaultValue

          -

          Defined in node_modules/@types/react/index.d.ts:1746

          +

          Defined in node_modules/@types/react/index.d.ts:1748


          Optional dir#

          dir? : string

          Inherited from ButtonProps.dir

          -

          Defined in node_modules/@types/react/index.d.ts:1755

          +

          Defined in node_modules/@types/react/index.d.ts:1757


          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

          Inherited from ButtonProps.draggable

          -

          Defined in node_modules/@types/react/index.d.ts:1756

          +

          Defined in node_modules/@types/react/index.d.ts:1758


          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

          Inherited from IconProps.hidden

          -

          Defined in node_modules/@types/react/index.d.ts:1757

          +

          Defined in node_modules/@types/react/index.d.ts:1759


          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

          Inherited from ButtonProps.id

          -

          Defined in node_modules/@types/react/index.d.ts:1758

          +

          Defined in node_modules/@types/react/index.d.ts:1760


          Optional inlist#

          inlist? : any

          Inherited from ButtonProps.inlist

          -

          Defined in node_modules/@types/react/index.d.ts:1777

          +

          Defined in node_modules/@types/react/index.d.ts:1779


          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

          +

          Defined in node_modules/@types/react/index.d.ts:1805

          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

          +

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1810

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1794


          Optional itemProp#

          itemProp? : string

          Inherited from ButtonProps.itemProp

          -

          Defined in node_modules/@types/react/index.d.ts:1789

          +

          Defined in node_modules/@types/react/index.d.ts:1791


          Optional itemRef#

          itemRef? : string

          Inherited from ButtonProps.itemRef

          -

          Defined in node_modules/@types/react/index.d.ts:1793

          +

          Defined in node_modules/@types/react/index.d.ts:1795


          Optional itemScope#

          itemScope? : boolean

          Inherited from ButtonProps.itemScope

          -

          Defined in node_modules/@types/react/index.d.ts:1790

          +

          Defined in node_modules/@types/react/index.d.ts:1792


          Optional itemType#

          itemType? : string

          Inherited from ButtonProps.itemType

          -

          Defined in node_modules/@types/react/index.d.ts:1791

          +

          Defined in node_modules/@types/react/index.d.ts:1793


          Optional lang#

          lang? : string

          Inherited from ButtonProps.lang

          -

          Defined in node_modules/@types/react/index.d.ts:1759

          +

          Defined in node_modules/@types/react/index.d.ts:1761


          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›

          Inherited from PageLayoutProps.onAbort

          -

          Defined in node_modules/@types/react/index.d.ts:1404

          +

          Defined in node_modules/@types/react/index.d.ts:1406


          Optional onAbortCapture#

          onAbortCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onAbortCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1405

          +

          Defined in node_modules/@types/react/index.d.ts:1407


          Optional onAnimationEnd#

          onAnimationEnd? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1534

          +

          Defined in node_modules/@types/react/index.d.ts:1536


          Optional onAnimationEndCapture#

          onAnimationEndCapture? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1535

          +

          Defined in node_modules/@types/react/index.d.ts:1537


          Optional onAnimationIteration#

          onAnimationIteration? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationIteration

          -

          Defined in node_modules/@types/react/index.d.ts:1536

          +

          Defined in node_modules/@types/react/index.d.ts:1538


          Optional onAnimationIterationCapture#

          onAnimationIterationCapture? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationIterationCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1537

          +

          Defined in node_modules/@types/react/index.d.ts:1539


          Optional onAnimationStart#

          onAnimationStart? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationStart

          -

          Defined in node_modules/@types/react/index.d.ts:1532

          +

          Defined in node_modules/@types/react/index.d.ts:1534


          Optional onAnimationStartCapture#

          onAnimationStartCapture? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1533

          +

          Defined in node_modules/@types/react/index.d.ts:1535


          Optional onAuxClick#

          onAuxClick? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onAuxClick

          -

          Defined in node_modules/@types/react/index.d.ts:1450

          +

          Defined in node_modules/@types/react/index.d.ts:1452


          Optional onAuxClickCapture#

          onAuxClickCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onAuxClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1451

          +

          Defined in node_modules/@types/react/index.d.ts:1453


          Optional onBeforeInput#

          onBeforeInput? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onBeforeInput

          -

          Defined in node_modules/@types/react/index.d.ts:1378

          +

          Defined in node_modules/@types/react/index.d.ts:1380


          Optional onBeforeInputCapture#

          onBeforeInputCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onBeforeInputCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1379

          +

          Defined in node_modules/@types/react/index.d.ts:1381


          Optional onBlur#

          onBlur? : FocusEventHandler‹any›

          Inherited from PageLayoutProps.onBlur

          -

          Defined in node_modules/@types/react/index.d.ts:1372

          +

          Defined in node_modules/@types/react/index.d.ts:1374


          Optional onBlurCapture#

          onBlurCapture? : FocusEventHandler‹any›

          Inherited from PageLayoutProps.onBlurCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1373

          +

          Defined in node_modules/@types/react/index.d.ts:1375


          Optional onCanPlay#

          onCanPlay? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onCanPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1406

          +

          Defined in node_modules/@types/react/index.d.ts:1408


          Optional onCanPlayCapture#

          onCanPlayCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onCanPlayCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1407

          +

          Defined in node_modules/@types/react/index.d.ts:1409


          Optional onCanPlayThrough#

          onCanPlayThrough? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onCanPlayThrough

          -

          Defined in node_modules/@types/react/index.d.ts:1408

          +

          Defined in node_modules/@types/react/index.d.ts:1410


          Optional onCanPlayThroughCapture#

          onCanPlayThroughCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onCanPlayThroughCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1409

          +

          Defined in node_modules/@types/react/index.d.ts:1411


          Optional onChange#

          onChange? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onChange

          -

          Defined in node_modules/@types/react/index.d.ts:1376

          +

          Defined in node_modules/@types/react/index.d.ts:1378


          Optional onChangeCapture#

          onChangeCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1377

          +

          Defined in node_modules/@types/react/index.d.ts:1379


          Optional onClick#

          onClick? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onClick

          -

          Defined in node_modules/@types/react/index.d.ts:1452

          +

          Defined in node_modules/@types/react/index.d.ts:1454


          Optional onClickCapture#

          onClickCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1453

          +

          Defined in node_modules/@types/react/index.d.ts:1455


          Optional onCompositionEnd#

          onCompositionEnd? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1362

          +

          Defined in node_modules/@types/react/index.d.ts:1364


          Optional onCompositionEndCapture#

          onCompositionEndCapture? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1363

          +

          Defined in node_modules/@types/react/index.d.ts:1365


          Optional onCompositionStart#

          onCompositionStart? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionStart

          -

          Defined in node_modules/@types/react/index.d.ts:1364

          +

          Defined in node_modules/@types/react/index.d.ts:1366


          Optional onCompositionStartCapture#

          onCompositionStartCapture? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1365

          +

          Defined in node_modules/@types/react/index.d.ts:1367


          Optional onCompositionUpdate#

          onCompositionUpdate? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionUpdate

          -

          Defined in node_modules/@types/react/index.d.ts:1366

          +

          Defined in node_modules/@types/react/index.d.ts:1368


          Optional onCompositionUpdateCapture#

          onCompositionUpdateCapture? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionUpdateCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1367

          +

          Defined in node_modules/@types/react/index.d.ts:1369


          Optional onContextMenu#

          onContextMenu? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onContextMenu

          -

          Defined in node_modules/@types/react/index.d.ts:1454

          +

          Defined in node_modules/@types/react/index.d.ts:1456


          Optional onContextMenuCapture#

          onContextMenuCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onContextMenuCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1455

          +

          Defined in node_modules/@types/react/index.d.ts:1457


          Optional onCopy#

          onCopy? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onCopy

          -

          Defined in node_modules/@types/react/index.d.ts:1354

          +

          Defined in node_modules/@types/react/index.d.ts:1356


          Optional onCopyCapture#

          onCopyCapture? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onCopyCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1355

          +

          Defined in node_modules/@types/react/index.d.ts:1357


          Optional onCut#

          onCut? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onCut

          -

          Defined in node_modules/@types/react/index.d.ts:1356

          +

          Defined in node_modules/@types/react/index.d.ts:1358


          Optional onCutCapture#

          onCutCapture? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onCutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1357

          +

          Defined in node_modules/@types/react/index.d.ts:1359


          Optional onDoubleClick#

          onDoubleClick? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onDoubleClick

          -

          Defined in node_modules/@types/react/index.d.ts:1456

          +

          Defined in node_modules/@types/react/index.d.ts:1458


          Optional onDoubleClickCapture#

          onDoubleClickCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onDoubleClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1457

          +

          Defined in node_modules/@types/react/index.d.ts:1459


          Optional onDrag#

          onDrag? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDrag

          -

          Defined in node_modules/@types/react/index.d.ts:1458

          +

          Defined in node_modules/@types/react/index.d.ts:1460


          Optional onDragCapture#

          onDragCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1459

          +

          Defined in node_modules/@types/react/index.d.ts:1461


          Optional onDragEnd#

          onDragEnd? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1460

          +

          Defined in node_modules/@types/react/index.d.ts:1462


          Optional onDragEndCapture#

          onDragEndCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1461

          +

          Defined in node_modules/@types/react/index.d.ts:1463


          Optional onDragEnter#

          onDragEnter? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1462

          +

          Defined in node_modules/@types/react/index.d.ts:1464


          Optional onDragEnterCapture#

          onDragEnterCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragEnterCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1463

          +

          Defined in node_modules/@types/react/index.d.ts:1465


          Optional onDragExit#

          onDragExit? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragExit

          -

          Defined in node_modules/@types/react/index.d.ts:1464

          +

          Defined in node_modules/@types/react/index.d.ts:1466


          Optional onDragExitCapture#

          onDragExitCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragExitCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1465

          +

          Defined in node_modules/@types/react/index.d.ts:1467


          Optional onDragLeave#

          onDragLeave? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1466

          +

          Defined in node_modules/@types/react/index.d.ts:1468


          Optional onDragLeaveCapture#

          onDragLeaveCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragLeaveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1467

          +

          Defined in node_modules/@types/react/index.d.ts:1469


          Optional onDragOver#

          onDragOver? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragOver

          -

          Defined in node_modules/@types/react/index.d.ts:1468

          +

          Defined in node_modules/@types/react/index.d.ts:1470


          Optional onDragOverCapture#

          onDragOverCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1469

          +

          Defined in node_modules/@types/react/index.d.ts:1471


          Optional onDragStart#

          onDragStart? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragStart

          -

          Defined in node_modules/@types/react/index.d.ts:1470

          +

          Defined in node_modules/@types/react/index.d.ts:1472


          Optional onDragStartCapture#

          onDragStartCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1471

          +

          Defined in node_modules/@types/react/index.d.ts:1473


          Optional onDrop#

          onDrop? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDrop

          -

          Defined in node_modules/@types/react/index.d.ts:1472

          +

          Defined in node_modules/@types/react/index.d.ts:1474


          Optional onDropCapture#

          onDropCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDropCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1473

          +

          Defined in node_modules/@types/react/index.d.ts:1475


          Optional onDurationChange#

          onDurationChange? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onDurationChange

          -

          Defined in node_modules/@types/react/index.d.ts:1410

          +

          Defined in node_modules/@types/react/index.d.ts:1412


          Optional onDurationChangeCapture#

          onDurationChangeCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onDurationChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1411

          +

          Defined in node_modules/@types/react/index.d.ts:1413


          Optional onEmptied#

          onEmptied? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEmptied

          -

          Defined in node_modules/@types/react/index.d.ts:1412

          +

          Defined in node_modules/@types/react/index.d.ts:1414


          Optional onEmptiedCapture#

          onEmptiedCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEmptiedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1413

          +

          Defined in node_modules/@types/react/index.d.ts:1415


          Optional onEncrypted#

          onEncrypted? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEncrypted

          -

          Defined in node_modules/@types/react/index.d.ts:1414

          +

          Defined in node_modules/@types/react/index.d.ts:1416


          Optional onEncryptedCapture#

          onEncryptedCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEncryptedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1415

          +

          Defined in node_modules/@types/react/index.d.ts:1417


          Optional onEnded#

          onEnded? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEnded

          -

          Defined in node_modules/@types/react/index.d.ts:1416

          +

          Defined in node_modules/@types/react/index.d.ts:1418


          Optional onEndedCapture#

          onEndedCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEndedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1417

          +

          Defined in node_modules/@types/react/index.d.ts:1419


          Optional onError#

          onError? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onError

          -

          Defined in node_modules/@types/react/index.d.ts:1392

          +

          Defined in node_modules/@types/react/index.d.ts:1394


          Optional onErrorCapture#

          onErrorCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onErrorCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1393

          +

          Defined in node_modules/@types/react/index.d.ts:1395


          Optional onFocus#

          onFocus? : FocusEventHandler‹any›

          Inherited from PageLayoutProps.onFocus

          -

          Defined in node_modules/@types/react/index.d.ts:1370

          +

          Defined in node_modules/@types/react/index.d.ts:1372


          Optional onFocusCapture#

          onFocusCapture? : FocusEventHandler‹any›

          Inherited from PageLayoutProps.onFocusCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1371

          +

          Defined in node_modules/@types/react/index.d.ts:1373


          Optional onGotPointerCapture#

          onGotPointerCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onGotPointerCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1518

          +

          Defined in node_modules/@types/react/index.d.ts:1520


          Optional onGotPointerCaptureCapture#

          onGotPointerCaptureCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onGotPointerCaptureCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1519

          +

          Defined in node_modules/@types/react/index.d.ts:1521


          Optional onInput#

          onInput? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onInput

          -

          Defined in node_modules/@types/react/index.d.ts:1380

          +

          Defined in node_modules/@types/react/index.d.ts:1382


          Optional onInputCapture#

          onInputCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onInputCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1381

          +

          Defined in node_modules/@types/react/index.d.ts:1383


          Optional onInvalid#

          onInvalid? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onInvalid

          -

          Defined in node_modules/@types/react/index.d.ts:1386

          +

          Defined in node_modules/@types/react/index.d.ts:1388


          Optional onInvalidCapture#

          onInvalidCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onInvalidCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1387

          +

          Defined in node_modules/@types/react/index.d.ts:1389


          Optional onKeyDown#

          onKeyDown? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyDown

          -

          Defined in node_modules/@types/react/index.d.ts:1396

          +

          Defined in node_modules/@types/react/index.d.ts:1398


          Optional onKeyDownCapture#

          onKeyDownCapture? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1397

          +

          Defined in node_modules/@types/react/index.d.ts:1399


          Optional onKeyPress#

          onKeyPress? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyPress

          -

          Defined in node_modules/@types/react/index.d.ts:1398

          +

          Defined in node_modules/@types/react/index.d.ts:1400


          Optional onKeyPressCapture#

          onKeyPressCapture? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyPressCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1399

          +

          Defined in node_modules/@types/react/index.d.ts:1401


          Optional onKeyUp#

          onKeyUp? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyUp

          -

          Defined in node_modules/@types/react/index.d.ts:1400

          +

          Defined in node_modules/@types/react/index.d.ts:1402


          Optional onKeyUpCapture#

          onKeyUpCapture? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1401

          +

          Defined in node_modules/@types/react/index.d.ts:1403


          Optional onLoad#

          onLoad? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoad

          -

          Defined in node_modules/@types/react/index.d.ts:1390

          +

          Defined in node_modules/@types/react/index.d.ts:1392


          Optional onLoadCapture#

          onLoadCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1391

          +

          Defined in node_modules/@types/react/index.d.ts:1393


          Optional onLoadStart#

          onLoadStart? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadStart

          -

          Defined in node_modules/@types/react/index.d.ts:1422

          +

          Defined in node_modules/@types/react/index.d.ts:1424


          Optional onLoadStartCapture#

          onLoadStartCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1423

          +

          Defined in node_modules/@types/react/index.d.ts:1425


          Optional onLoadedData#

          onLoadedData? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadedData

          -

          Defined in node_modules/@types/react/index.d.ts:1418

          +

          Defined in node_modules/@types/react/index.d.ts:1420


          Optional onLoadedDataCapture#

          onLoadedDataCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadedDataCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1419

          +

          Defined in node_modules/@types/react/index.d.ts:1421


          Optional onLoadedMetadata#

          onLoadedMetadata? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadedMetadata

          -

          Defined in node_modules/@types/react/index.d.ts:1420

          +

          Defined in node_modules/@types/react/index.d.ts:1422


          Optional onLoadedMetadataCapture#

          onLoadedMetadataCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadedMetadataCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1421

          +

          Defined in node_modules/@types/react/index.d.ts:1423


          Optional onLostPointerCapture#

          onLostPointerCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onLostPointerCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1520

          +

          Defined in node_modules/@types/react/index.d.ts:1522


          Optional onLostPointerCaptureCapture#

          onLostPointerCaptureCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onLostPointerCaptureCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1521

          +

          Defined in node_modules/@types/react/index.d.ts:1523


          Optional onMouseDown#

          onMouseDown? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseDown

          -

          Defined in node_modules/@types/react/index.d.ts:1474

          +

          Defined in node_modules/@types/react/index.d.ts:1476


          Optional onMouseDownCapture#

          onMouseDownCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1475

          +

          Defined in node_modules/@types/react/index.d.ts:1477


          Optional onMouseEnter#

          onMouseEnter? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1476

          +

          Defined in node_modules/@types/react/index.d.ts:1478


          Optional onMouseLeave#

          onMouseLeave? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1477

          +

          Defined in node_modules/@types/react/index.d.ts:1479


          Optional onMouseMove#

          onMouseMove? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseMove

          -

          Defined in node_modules/@types/react/index.d.ts:1478

          +

          Defined in node_modules/@types/react/index.d.ts:1480


          Optional onMouseMoveCapture#

          onMouseMoveCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1479

          +

          Defined in node_modules/@types/react/index.d.ts:1481


          Optional onMouseOut#

          onMouseOut? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseOut

          -

          Defined in node_modules/@types/react/index.d.ts:1480

          +

          Defined in node_modules/@types/react/index.d.ts:1482


          Optional onMouseOutCapture#

          onMouseOutCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseOutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1481

          +

          Defined in node_modules/@types/react/index.d.ts:1483


          Optional onMouseOver#

          onMouseOver? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseOver

          -

          Defined in node_modules/@types/react/index.d.ts:1482

          +

          Defined in node_modules/@types/react/index.d.ts:1484


          Optional onMouseOverCapture#

          onMouseOverCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1483

          +

          Defined in node_modules/@types/react/index.d.ts:1485


          Optional onMouseUp#

          onMouseUp? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseUp

          -

          Defined in node_modules/@types/react/index.d.ts:1484

          +

          Defined in node_modules/@types/react/index.d.ts:1486


          Optional onMouseUpCapture#

          onMouseUpCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1485

          +

          Defined in node_modules/@types/react/index.d.ts:1487


          Optional onPaste#

          onPaste? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onPaste

          -

          Defined in node_modules/@types/react/index.d.ts:1358

          +

          Defined in node_modules/@types/react/index.d.ts:1360


          Optional onPasteCapture#

          onPasteCapture? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onPasteCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1359

          +

          Defined in node_modules/@types/react/index.d.ts:1361


          Optional onPause#

          onPause? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPause

          -

          Defined in node_modules/@types/react/index.d.ts:1424

          +

          Defined in node_modules/@types/react/index.d.ts:1426


          Optional onPauseCapture#

          onPauseCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPauseCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1425

          +

          Defined in node_modules/@types/react/index.d.ts:1427


          Optional onPlay#

          onPlay? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1426

          +

          Defined in node_modules/@types/react/index.d.ts:1428


          Optional onPlayCapture#

          onPlayCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPlayCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1427

          +

          Defined in node_modules/@types/react/index.d.ts:1429


          Optional onPlaying#

          onPlaying? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPlaying

          -

          Defined in node_modules/@types/react/index.d.ts:1428

          +

          Defined in node_modules/@types/react/index.d.ts:1430


          Optional onPlayingCapture#

          onPlayingCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPlayingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1429

          +

          Defined in node_modules/@types/react/index.d.ts:1431


          Optional onPointerCancel#

          onPointerCancel? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerCancel

          -

          Defined in node_modules/@types/react/index.d.ts:1508

          +

          Defined in node_modules/@types/react/index.d.ts:1510


          Optional onPointerCancelCapture#

          onPointerCancelCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerCancelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1509

          +

          Defined in node_modules/@types/react/index.d.ts:1511


          Optional onPointerDown#

          onPointerDown? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerDown

          -

          Defined in node_modules/@types/react/index.d.ts:1502

          +

          Defined in node_modules/@types/react/index.d.ts:1504


          Optional onPointerDownCapture#

          onPointerDownCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1503

          +

          Defined in node_modules/@types/react/index.d.ts:1505


          Optional onPointerEnter#

          onPointerEnter? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1510

          +

          Defined in node_modules/@types/react/index.d.ts:1512


          Optional onPointerEnterCapture#

          onPointerEnterCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerEnterCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1511

          +

          Defined in node_modules/@types/react/index.d.ts:1513


          Optional onPointerLeave#

          onPointerLeave? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1512

          +

          Defined in node_modules/@types/react/index.d.ts:1514


          Optional onPointerLeaveCapture#

          onPointerLeaveCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerLeaveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1513

          +

          Defined in node_modules/@types/react/index.d.ts:1515


          Optional onPointerMove#

          onPointerMove? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerMove

          -

          Defined in node_modules/@types/react/index.d.ts:1504

          +

          Defined in node_modules/@types/react/index.d.ts:1506


          Optional onPointerMoveCapture#

          onPointerMoveCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1505

          +

          Defined in node_modules/@types/react/index.d.ts:1507


          Optional onPointerOut#

          onPointerOut? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerOut

          -

          Defined in node_modules/@types/react/index.d.ts:1516

          +

          Defined in node_modules/@types/react/index.d.ts:1518


          Optional onPointerOutCapture#

          onPointerOutCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerOutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1517

          +

          Defined in node_modules/@types/react/index.d.ts:1519


          Optional onPointerOver#

          onPointerOver? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerOver

          -

          Defined in node_modules/@types/react/index.d.ts:1514

          +

          Defined in node_modules/@types/react/index.d.ts:1516


          Optional onPointerOverCapture#

          onPointerOverCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1515

          +

          Defined in node_modules/@types/react/index.d.ts:1517


          Optional onPointerUp#

          onPointerUp? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerUp

          -

          Defined in node_modules/@types/react/index.d.ts:1506

          +

          Defined in node_modules/@types/react/index.d.ts:1508


          Optional onPointerUpCapture#

          onPointerUpCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1507

          +

          Defined in node_modules/@types/react/index.d.ts:1509


          Optional onProgress#

          onProgress? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onProgress

          -

          Defined in node_modules/@types/react/index.d.ts:1430

          +

          Defined in node_modules/@types/react/index.d.ts:1432


          Optional onProgressCapture#

          onProgressCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onProgressCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1431

          +

          Defined in node_modules/@types/react/index.d.ts:1433


          Optional onRateChange#

          onRateChange? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onRateChange

          -

          Defined in node_modules/@types/react/index.d.ts:1432

          +

          Defined in node_modules/@types/react/index.d.ts:1434


          Optional onRateChangeCapture#

          onRateChangeCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onRateChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1433

          +

          Defined in node_modules/@types/react/index.d.ts:1435


          Optional onReset#

          onReset? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onReset

          -

          Defined in node_modules/@types/react/index.d.ts:1382

          +

          Defined in node_modules/@types/react/index.d.ts:1384


          Optional onResetCapture#

          onResetCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onResetCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1383

          +

          Defined in node_modules/@types/react/index.d.ts:1385


          Optional onScroll#

          onScroll? : UIEventHandler‹any›

          Inherited from PageLayoutProps.onScroll

          -

          Defined in node_modules/@types/react/index.d.ts:1524

          +

          Defined in node_modules/@types/react/index.d.ts:1526


          Optional onScrollCapture#

          onScrollCapture? : UIEventHandler‹any›

          Inherited from PageLayoutProps.onScrollCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1525

          +

          Defined in node_modules/@types/react/index.d.ts:1527


          Optional onSeeked#

          onSeeked? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSeeked

          -

          Defined in node_modules/@types/react/index.d.ts:1434

          +

          Defined in node_modules/@types/react/index.d.ts:1436


          Optional onSeekedCapture#

          onSeekedCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSeekedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1435

          +

          Defined in node_modules/@types/react/index.d.ts:1437


          Optional onSeeking#

          onSeeking? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSeeking

          -

          Defined in node_modules/@types/react/index.d.ts:1436

          +

          Defined in node_modules/@types/react/index.d.ts:1438


          Optional onSeekingCapture#

          onSeekingCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSeekingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1437

          +

          Defined in node_modules/@types/react/index.d.ts:1439


          Optional onSelect#

          onSelect? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSelect

          -

          Defined in node_modules/@types/react/index.d.ts:1488

          +

          Defined in node_modules/@types/react/index.d.ts:1490


          Optional onSelectCapture#

          onSelectCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSelectCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1489

          +

          Defined in node_modules/@types/react/index.d.ts:1491


          Optional onStalled#

          onStalled? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onStalled

          -

          Defined in node_modules/@types/react/index.d.ts:1438

          +

          Defined in node_modules/@types/react/index.d.ts:1440


          Optional onStalledCapture#

          onStalledCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onStalledCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1439

          +

          Defined in node_modules/@types/react/index.d.ts:1441


          Optional onSubmit#

          onSubmit? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onSubmit

          -

          Defined in node_modules/@types/react/index.d.ts:1384

          +

          Defined in node_modules/@types/react/index.d.ts:1386


          Optional onSubmitCapture#

          onSubmitCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onSubmitCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1385

          +

          Defined in node_modules/@types/react/index.d.ts:1387


          Optional onSuspend#

          onSuspend? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSuspend

          -

          Defined in node_modules/@types/react/index.d.ts:1440

          +

          Defined in node_modules/@types/react/index.d.ts:1442


          Optional onSuspendCapture#

          onSuspendCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSuspendCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1441

          +

          Defined in node_modules/@types/react/index.d.ts:1443


          Optional onTimeUpdate#

          onTimeUpdate? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onTimeUpdate

          -

          Defined in node_modules/@types/react/index.d.ts:1442

          +

          Defined in node_modules/@types/react/index.d.ts:1444


          Optional onTimeUpdateCapture#

          onTimeUpdateCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onTimeUpdateCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1443

          +

          Defined in node_modules/@types/react/index.d.ts:1445


          Optional onTouchCancel#

          onTouchCancel? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchCancel

          -

          Defined in node_modules/@types/react/index.d.ts:1492

          +

          Defined in node_modules/@types/react/index.d.ts:1494


          Optional onTouchCancelCapture#

          onTouchCancelCapture? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchCancelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1493

          +

          Defined in node_modules/@types/react/index.d.ts:1495


          Optional onTouchEnd#

          onTouchEnd? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1494

          +

          Defined in node_modules/@types/react/index.d.ts:1496


          Optional onTouchEndCapture#

          onTouchEndCapture? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1495

          +

          Defined in node_modules/@types/react/index.d.ts:1497


          Optional onTouchMove#

          onTouchMove? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchMove

          -

          Defined in node_modules/@types/react/index.d.ts:1496

          +

          Defined in node_modules/@types/react/index.d.ts:1498


          Optional onTouchMoveCapture#

          onTouchMoveCapture? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1497

          +

          Defined in node_modules/@types/react/index.d.ts:1499


          Optional onTouchStart#

          onTouchStart? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchStart

          -

          Defined in node_modules/@types/react/index.d.ts:1498

          +

          Defined in node_modules/@types/react/index.d.ts:1500


          Optional onTouchStartCapture#

          onTouchStartCapture? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1499

          +

          Defined in node_modules/@types/react/index.d.ts:1501


          Optional onTransitionEnd#

          onTransitionEnd? : TransitionEventHandler‹any›

          Inherited from PageLayoutProps.onTransitionEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1540

          +

          Defined in node_modules/@types/react/index.d.ts:1542


          Optional onTransitionEndCapture#

          onTransitionEndCapture? : TransitionEventHandler‹any›

          Inherited from PageLayoutProps.onTransitionEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1541

          +

          Defined in node_modules/@types/react/index.d.ts:1543


          Optional onVolumeChange#

          onVolumeChange? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onVolumeChange

          -

          Defined in node_modules/@types/react/index.d.ts:1444

          +

          Defined in node_modules/@types/react/index.d.ts:1446


          Optional onVolumeChangeCapture#

          onVolumeChangeCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onVolumeChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1445

          +

          Defined in node_modules/@types/react/index.d.ts:1447


          Optional onWaiting#

          onWaiting? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onWaiting

          -

          Defined in node_modules/@types/react/index.d.ts:1446

          +

          Defined in node_modules/@types/react/index.d.ts:1448


          Optional onWaitingCapture#

          onWaitingCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onWaitingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1447

          +

          Defined in node_modules/@types/react/index.d.ts:1449


          Optional onWheel#

          onWheel? : WheelEventHandler‹any›

          Inherited from PageLayoutProps.onWheel

          -

          Defined in node_modules/@types/react/index.d.ts:1528

          +

          Defined in node_modules/@types/react/index.d.ts:1530


          Optional onWheelCapture#

          onWheelCapture? : WheelEventHandler‹any›

          Inherited from PageLayoutProps.onWheelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1529

          +

          Defined in node_modules/@types/react/index.d.ts:1531


          Optional placeholder#

          placeholder? : string

          Inherited from ButtonProps.placeholder

          -

          Defined in node_modules/@types/react/index.d.ts:1760

          +

          Defined in node_modules/@types/react/index.d.ts:1762


          Optional prefix#

          prefix? : string

          Inherited from ButtonProps.prefix

          -

          Defined in node_modules/@types/react/index.d.ts:1778

          +

          Defined in node_modules/@types/react/index.d.ts:1780


          Optional property#

          property? : string

          Inherited from ButtonProps.property

          -

          Defined in node_modules/@types/react/index.d.ts:1779

          +

          Defined in node_modules/@types/react/index.d.ts:1781


          Optional radioGroup#

          radioGroup? : string

          Inherited from ButtonProps.radioGroup

          -

          Defined in node_modules/@types/react/index.d.ts:1769

          +

          Defined in node_modules/@types/react/index.d.ts:1771


          Optional resource#

          resource? : string

          Inherited from ButtonProps.resource

          -

          Defined in node_modules/@types/react/index.d.ts:1780

          +

          Defined in node_modules/@types/react/index.d.ts:1782


          Optional results#

          results? : number

          Inherited from ButtonProps.results

          -

          Defined in node_modules/@types/react/index.d.ts:1794

          +

          Defined in node_modules/@types/react/index.d.ts:1796


          Optional role#

          role? : string

          Inherited from ButtonProps.role

          -

          Defined in node_modules/@types/react/index.d.ts:1772

          +

          Defined in node_modules/@types/react/index.d.ts:1774


          Optional security#

          security? : string

          Inherited from ButtonProps.security

          -

          Defined in node_modules/@types/react/index.d.ts:1795

          +

          Defined in node_modules/@types/react/index.d.ts:1797


          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

          Inherited from ButtonProps.slot

          -

          Defined in node_modules/@types/react/index.d.ts:1761

          +

          Defined in node_modules/@types/react/index.d.ts:1763


          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

          Inherited from ButtonProps.spellCheck

          -

          Defined in node_modules/@types/react/index.d.ts:1762

          +

          Defined in node_modules/@types/react/index.d.ts:1764


          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

          Inherited from ButtonProps.style

          -

          Defined in node_modules/@types/react/index.d.ts:1763

          +

          Defined in node_modules/@types/react/index.d.ts:1765


          Optional suppressContentEditableWarning#

          suppressContentEditableWarning? : boolean

          Inherited from ButtonProps.suppressContentEditableWarning

          -

          Defined in node_modules/@types/react/index.d.ts:1747

          +

          Defined in node_modules/@types/react/index.d.ts:1749


          Optional suppressHydrationWarning#

          suppressHydrationWarning? : boolean

          Inherited from ButtonProps.suppressHydrationWarning

          -

          Defined in node_modules/@types/react/index.d.ts:1748

          +

          Defined in node_modules/@types/react/index.d.ts:1750


          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

          Inherited from ButtonProps.tabIndex

          -

          Defined in node_modules/@types/react/index.d.ts:1764

          +

          Defined in node_modules/@types/react/index.d.ts:1766


          Optional title#

          title? : string

          Inherited from ButtonProps.title

          -

          Defined in node_modules/@types/react/index.d.ts:1765

          +

          Defined in node_modules/@types/react/index.d.ts:1767


          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"


          Optional translate#

          translate? : "yes" | "no"

          Inherited from ButtonProps.translate

          -

          Defined in node_modules/@types/react/index.d.ts:1766

          +

          Defined in node_modules/@types/react/index.d.ts:1768


          Optional typeof#

          typeof? : string

          Inherited from ButtonProps.typeof

          -

          Defined in node_modules/@types/react/index.d.ts:1781

          +

          Defined in node_modules/@types/react/index.d.ts:1783


          Optional unselectable#

          unselectable? : "on" | "off"

          Inherited from ButtonProps.unselectable

          -

          Defined in node_modules/@types/react/index.d.ts:1796

          +

          Defined in node_modules/@types/react/index.d.ts:1798


          Optional vocab#

          vocab? : string

          Inherited from ButtonProps.vocab

          -

          Defined in node_modules/@types/react/index.d.ts:1782

          +

          Defined in node_modules/@types/react/index.d.ts:1784

          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 e392153af5..13e3b1d9e4 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -598,7 +598,7 @@
        • - Working with mobx + Working with MobX
        • @@ -934,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:6


          Optional message#

          message? : ReactNode | function

          -

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

          +

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

          Methods#

          Optional condition#

          condition(props: InputProps): boolean

          -

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

          +

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

          Parameters:

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

    validate#

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

    -

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

    +

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

    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 5a5b8e6e26..8fe23d7da2 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -887,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:11

    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 af5a484a5b..4ccd462087 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -904,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:54


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

    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 1cb55d7838..8533e95355 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -944,6 +944,13 @@ Optional isClusterScoped + + +
  • + + Optional isConfigurable + +
  • @@ -965,6 +972,13 @@ Optional isSelectable +
  • + +
  • + + Optional items + +
  • @@ -972,6 +986,13 @@ Optional onDetails +
  • + +
  • + + Optional preloadStores + +
  • @@ -1035,6 +1056,13 @@ store +
  • + +
  • + + Optional tableId + +
  • @@ -1094,10 +1122,13 @@
  • headerClassName
  • hideFilters
  • isClusterScoped
  • +
  • isConfigurable
  • isReady
  • isSearchable
  • isSelectable
  • +
  • items
  • onDetails
  • +
  • preloadStores
  • renderFooter
  • renderHeaderTitle
  • renderItemMenu
  • @@ -1107,6 +1138,7 @@
  • showHeader
  • sortingCallbacks
  • store
  • +
  • tableId
  • tableProps
  • virtual
  • @@ -1114,22 +1146,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:68


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


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


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

    Type declaration:

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

    Parameters:

    @@ -1155,7 +1187,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:77

    Type declaration:

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

    Parameters:

    @@ -1177,7 +1209,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:67

    Type declaration:

    ▸ (item: T): Partial‹TableRowProps

    Parameters:

    @@ -1197,59 +1229,69 @@

    Optional dependentStores#

    -

    dependentStores? : ItemStore[]

    -

    Inherited from KubeObjectListLayoutProps.dependentStores

    -

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

    +

    dependentStores? : KubeObjectStore[]

    +

    Overrides void

    +

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


    Optional detailsItem#

    detailsItem? : T

    Inherited from KubeObjectListLayoutProps.detailsItem

    -

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

    +

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


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


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


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


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


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

    +
    +

    Optional isConfigurable#

    +

    isConfigurable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isConfigurable

    +

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


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


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


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

    +
    +

    Optional items#

    +

    items? : T[]

    +

    Inherited from KubeObjectListLayoutProps.items

    +

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


    Optional onDetails#

    onDetails? : function

    Inherited from KubeObjectListLayoutProps.onDetails

    -

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

    +

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

    Type declaration:

    ▸ (item: T): void

    Parameters:

    @@ -1268,10 +1310,15 @@
    +

    Optional preloadStores#

    +

    preloadStores? : boolean

    +

    Inherited from KubeObjectListLayoutProps.preloadStores

    +

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

    +

    Optional renderFooter#

    renderFooter? : function

    Inherited from KubeObjectListLayoutProps.renderFooter

    -

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

    +

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

    Type declaration:

    ▸ (parent: ItemListLayout): React.ReactNode

    Parameters:

    @@ -1293,12 +1340,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:53


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

    Type declaration:

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

    Parameters:

    @@ -1324,7 +1371,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:65

    Type declaration:

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

    Parameters:

    @@ -1346,22 +1393,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:64


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


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


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

    Type declaration:

    • [ sortBy: string]: TableSortCallback
    • @@ -1370,17 +1417,22 @@

      store#

      store: KubeObjectStore

      Overrides void

      -

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

      +

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

      +
      +

      Optional tableId#

      +

      tableId? : string

      +

      Inherited from KubeObjectListLayoutProps.tableId

      +

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


      Optional tableProps#

      tableProps? : Partial‹TableProps

      Inherited from KubeObjectListLayoutProps.tableProps

      -

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

      +

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


      Optional virtual#

      virtual? : boolean

      Inherited from KubeObjectListLayoutProps.virtual

      -

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

      +

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

      diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html index 3325baf341..6b802051eb 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -862,6 +862,13 @@ + + +
    • + + Methods + + + +
    @@ -908,22 +935,31 @@
  • status
  • timeout
  • +

    Methods#

    +

    Properties#

    Optional id#

    id? : NotificationId

    -

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

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:17


    message#

    message: NotificationMessage

    -

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

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:18


    Optional status#

    status? : NotificationStatus

    -

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

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:19


    Optional timeout#

    timeout? : number

    -

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

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:20

    +

    Methods#

    +

    Optional onClose#

    +

    onClose(): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:21

    +

    Returns: void

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html index eb059a8bfe..6ba0616802 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -2240,7 +2240,7 @@

    Properties#

    Optional back#

    back? : function

    -

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

    +

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

    Type declaration:

    ▸ (evt: MouseEvent | KeyboardEvent): void

    Parameters:

    @@ -2262,24 +2262,24 @@

    Optional children#

    children? : ReactNode

    Inherited from PageLayoutProps.children

    -

    Defined in node_modules/@types/react/index.d.ts:1348

    +

    Defined in node_modules/@types/react/index.d.ts:1350


    Optional className#

    className? : IClassName

    -

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

    +

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


    Optional contentClass#

    contentClass? : IClassName

    -

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

    +

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


    Optional contentGaps#

    contentGaps? : boolean

    -

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

    +

    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

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    Type declaration:

    • __html: string
    • @@ -2287,819 +2287,819 @@

      header: React.ReactNode

      -

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

      +

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


      Optional headerClass#

      headerClass? : IClassName

      -

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

      +

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1406


      Optional onAbortCapture#

      onAbortCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onAbortCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1405

      +

      Defined in node_modules/@types/react/index.d.ts:1407


      Optional onAnimationEnd#

      onAnimationEnd? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1534

      +

      Defined in node_modules/@types/react/index.d.ts:1536


      Optional onAnimationEndCapture#

      onAnimationEndCapture? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1535

      +

      Defined in node_modules/@types/react/index.d.ts:1537


      Optional onAnimationIteration#

      onAnimationIteration? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationIteration

      -

      Defined in node_modules/@types/react/index.d.ts:1536

      +

      Defined in node_modules/@types/react/index.d.ts:1538


      Optional onAnimationIterationCapture#

      onAnimationIterationCapture? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationIterationCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1537

      +

      Defined in node_modules/@types/react/index.d.ts:1539


      Optional onAnimationStart#

      onAnimationStart? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationStart

      -

      Defined in node_modules/@types/react/index.d.ts:1532

      +

      Defined in node_modules/@types/react/index.d.ts:1534


      Optional onAnimationStartCapture#

      onAnimationStartCapture? : AnimationEventHandler‹any›

      Inherited from PageLayoutProps.onAnimationStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1533

      +

      Defined in node_modules/@types/react/index.d.ts:1535


      Optional onAuxClick#

      onAuxClick? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onAuxClick

      -

      Defined in node_modules/@types/react/index.d.ts:1450

      +

      Defined in node_modules/@types/react/index.d.ts:1452


      Optional onAuxClickCapture#

      onAuxClickCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onAuxClickCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1451

      +

      Defined in node_modules/@types/react/index.d.ts:1453


      Optional onBeforeInput#

      onBeforeInput? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onBeforeInput

      -

      Defined in node_modules/@types/react/index.d.ts:1378

      +

      Defined in node_modules/@types/react/index.d.ts:1380


      Optional onBeforeInputCapture#

      onBeforeInputCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onBeforeInputCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1379

      +

      Defined in node_modules/@types/react/index.d.ts:1381


      Optional onBlur#

      onBlur? : FocusEventHandler‹any›

      Inherited from PageLayoutProps.onBlur

      -

      Defined in node_modules/@types/react/index.d.ts:1372

      +

      Defined in node_modules/@types/react/index.d.ts:1374


      Optional onBlurCapture#

      onBlurCapture? : FocusEventHandler‹any›

      Inherited from PageLayoutProps.onBlurCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1373

      +

      Defined in node_modules/@types/react/index.d.ts:1375


      Optional onCanPlay#

      onCanPlay? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onCanPlay

      -

      Defined in node_modules/@types/react/index.d.ts:1406

      +

      Defined in node_modules/@types/react/index.d.ts:1408


      Optional onCanPlayCapture#

      onCanPlayCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onCanPlayCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1407

      +

      Defined in node_modules/@types/react/index.d.ts:1409


      Optional onCanPlayThrough#

      onCanPlayThrough? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onCanPlayThrough

      -

      Defined in node_modules/@types/react/index.d.ts:1408

      +

      Defined in node_modules/@types/react/index.d.ts:1410


      Optional onCanPlayThroughCapture#

      onCanPlayThroughCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onCanPlayThroughCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1409

      +

      Defined in node_modules/@types/react/index.d.ts:1411


      Optional onChange#

      onChange? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onChange

      -

      Defined in node_modules/@types/react/index.d.ts:1376

      +

      Defined in node_modules/@types/react/index.d.ts:1378


      Optional onChangeCapture#

      onChangeCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onChangeCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1377

      +

      Defined in node_modules/@types/react/index.d.ts:1379


      Optional onClick#

      onClick? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onClick

      -

      Defined in node_modules/@types/react/index.d.ts:1452

      +

      Defined in node_modules/@types/react/index.d.ts:1454


      Optional onClickCapture#

      onClickCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onClickCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1453

      +

      Defined in node_modules/@types/react/index.d.ts:1455


      Optional onCompositionEnd#

      onCompositionEnd? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1362

      +

      Defined in node_modules/@types/react/index.d.ts:1364


      Optional onCompositionEndCapture#

      onCompositionEndCapture? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1363

      +

      Defined in node_modules/@types/react/index.d.ts:1365


      Optional onCompositionStart#

      onCompositionStart? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionStart

      -

      Defined in node_modules/@types/react/index.d.ts:1364

      +

      Defined in node_modules/@types/react/index.d.ts:1366


      Optional onCompositionStartCapture#

      onCompositionStartCapture? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1365

      +

      Defined in node_modules/@types/react/index.d.ts:1367


      Optional onCompositionUpdate#

      onCompositionUpdate? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionUpdate

      -

      Defined in node_modules/@types/react/index.d.ts:1366

      +

      Defined in node_modules/@types/react/index.d.ts:1368


      Optional onCompositionUpdateCapture#

      onCompositionUpdateCapture? : CompositionEventHandler‹any›

      Inherited from PageLayoutProps.onCompositionUpdateCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1367

      +

      Defined in node_modules/@types/react/index.d.ts:1369


      Optional onContextMenu#

      onContextMenu? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onContextMenu

      -

      Defined in node_modules/@types/react/index.d.ts:1454

      +

      Defined in node_modules/@types/react/index.d.ts:1456


      Optional onContextMenuCapture#

      onContextMenuCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onContextMenuCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1455

      +

      Defined in node_modules/@types/react/index.d.ts:1457


      Optional onCopy#

      onCopy? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onCopy

      -

      Defined in node_modules/@types/react/index.d.ts:1354

      +

      Defined in node_modules/@types/react/index.d.ts:1356


      Optional onCopyCapture#

      onCopyCapture? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onCopyCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1355

      +

      Defined in node_modules/@types/react/index.d.ts:1357


      Optional onCut#

      onCut? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onCut

      -

      Defined in node_modules/@types/react/index.d.ts:1356

      +

      Defined in node_modules/@types/react/index.d.ts:1358


      Optional onCutCapture#

      onCutCapture? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onCutCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1357

      +

      Defined in node_modules/@types/react/index.d.ts:1359


      Optional onDoubleClick#

      onDoubleClick? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onDoubleClick

      -

      Defined in node_modules/@types/react/index.d.ts:1456

      +

      Defined in node_modules/@types/react/index.d.ts:1458


      Optional onDoubleClickCapture#

      onDoubleClickCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onDoubleClickCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1457

      +

      Defined in node_modules/@types/react/index.d.ts:1459


      Optional onDrag#

      onDrag? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDrag

      -

      Defined in node_modules/@types/react/index.d.ts:1458

      +

      Defined in node_modules/@types/react/index.d.ts:1460


      Optional onDragCapture#

      onDragCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1459

      +

      Defined in node_modules/@types/react/index.d.ts:1461


      Optional onDragEnd#

      onDragEnd? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1460

      +

      Defined in node_modules/@types/react/index.d.ts:1462


      Optional onDragEndCapture#

      onDragEndCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1461

      +

      Defined in node_modules/@types/react/index.d.ts:1463


      Optional onDragEnter#

      onDragEnter? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragEnter

      -

      Defined in node_modules/@types/react/index.d.ts:1462

      +

      Defined in node_modules/@types/react/index.d.ts:1464


      Optional onDragEnterCapture#

      onDragEnterCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragEnterCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1463

      +

      Defined in node_modules/@types/react/index.d.ts:1465


      Optional onDragExit#

      onDragExit? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragExit

      -

      Defined in node_modules/@types/react/index.d.ts:1464

      +

      Defined in node_modules/@types/react/index.d.ts:1466


      Optional onDragExitCapture#

      onDragExitCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragExitCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1465

      +

      Defined in node_modules/@types/react/index.d.ts:1467


      Optional onDragLeave#

      onDragLeave? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragLeave

      -

      Defined in node_modules/@types/react/index.d.ts:1466

      +

      Defined in node_modules/@types/react/index.d.ts:1468


      Optional onDragLeaveCapture#

      onDragLeaveCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragLeaveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1467

      +

      Defined in node_modules/@types/react/index.d.ts:1469


      Optional onDragOver#

      onDragOver? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragOver

      -

      Defined in node_modules/@types/react/index.d.ts:1468

      +

      Defined in node_modules/@types/react/index.d.ts:1470


      Optional onDragOverCapture#

      onDragOverCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragOverCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1469

      +

      Defined in node_modules/@types/react/index.d.ts:1471


      Optional onDragStart#

      onDragStart? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragStart

      -

      Defined in node_modules/@types/react/index.d.ts:1470

      +

      Defined in node_modules/@types/react/index.d.ts:1472


      Optional onDragStartCapture#

      onDragStartCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDragStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1471

      +

      Defined in node_modules/@types/react/index.d.ts:1473


      Optional onDrop#

      onDrop? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDrop

      -

      Defined in node_modules/@types/react/index.d.ts:1472

      +

      Defined in node_modules/@types/react/index.d.ts:1474


      Optional onDropCapture#

      onDropCapture? : DragEventHandler‹any›

      Inherited from PageLayoutProps.onDropCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1473

      +

      Defined in node_modules/@types/react/index.d.ts:1475


      Optional onDurationChange#

      onDurationChange? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onDurationChange

      -

      Defined in node_modules/@types/react/index.d.ts:1410

      +

      Defined in node_modules/@types/react/index.d.ts:1412


      Optional onDurationChangeCapture#

      onDurationChangeCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onDurationChangeCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1411

      +

      Defined in node_modules/@types/react/index.d.ts:1413


      Optional onEmptied#

      onEmptied? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEmptied

      -

      Defined in node_modules/@types/react/index.d.ts:1412

      +

      Defined in node_modules/@types/react/index.d.ts:1414


      Optional onEmptiedCapture#

      onEmptiedCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEmptiedCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1413

      +

      Defined in node_modules/@types/react/index.d.ts:1415


      Optional onEncrypted#

      onEncrypted? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEncrypted

      -

      Defined in node_modules/@types/react/index.d.ts:1414

      +

      Defined in node_modules/@types/react/index.d.ts:1416


      Optional onEncryptedCapture#

      onEncryptedCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEncryptedCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1415

      +

      Defined in node_modules/@types/react/index.d.ts:1417


      Optional onEnded#

      onEnded? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEnded

      -

      Defined in node_modules/@types/react/index.d.ts:1416

      +

      Defined in node_modules/@types/react/index.d.ts:1418


      Optional onEndedCapture#

      onEndedCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onEndedCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1417

      +

      Defined in node_modules/@types/react/index.d.ts:1419


      Optional onError#

      onError? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onError

      -

      Defined in node_modules/@types/react/index.d.ts:1392

      +

      Defined in node_modules/@types/react/index.d.ts:1394


      Optional onErrorCapture#

      onErrorCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onErrorCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1393

      +

      Defined in node_modules/@types/react/index.d.ts:1395


      Optional onFocus#

      onFocus? : FocusEventHandler‹any›

      Inherited from PageLayoutProps.onFocus

      -

      Defined in node_modules/@types/react/index.d.ts:1370

      +

      Defined in node_modules/@types/react/index.d.ts:1372


      Optional onFocusCapture#

      onFocusCapture? : FocusEventHandler‹any›

      Inherited from PageLayoutProps.onFocusCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1371

      +

      Defined in node_modules/@types/react/index.d.ts:1373


      Optional onGotPointerCapture#

      onGotPointerCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onGotPointerCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1518

      +

      Defined in node_modules/@types/react/index.d.ts:1520


      Optional onGotPointerCaptureCapture#

      onGotPointerCaptureCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onGotPointerCaptureCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1519

      +

      Defined in node_modules/@types/react/index.d.ts:1521


      Optional onInput#

      onInput? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onInput

      -

      Defined in node_modules/@types/react/index.d.ts:1380

      +

      Defined in node_modules/@types/react/index.d.ts:1382


      Optional onInputCapture#

      onInputCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onInputCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1381

      +

      Defined in node_modules/@types/react/index.d.ts:1383


      Optional onInvalid#

      onInvalid? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onInvalid

      -

      Defined in node_modules/@types/react/index.d.ts:1386

      +

      Defined in node_modules/@types/react/index.d.ts:1388


      Optional onInvalidCapture#

      onInvalidCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onInvalidCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1387

      +

      Defined in node_modules/@types/react/index.d.ts:1389


      Optional onKeyDown#

      onKeyDown? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyDown

      -

      Defined in node_modules/@types/react/index.d.ts:1396

      +

      Defined in node_modules/@types/react/index.d.ts:1398


      Optional onKeyDownCapture#

      onKeyDownCapture? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyDownCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1397

      +

      Defined in node_modules/@types/react/index.d.ts:1399


      Optional onKeyPress#

      onKeyPress? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyPress

      -

      Defined in node_modules/@types/react/index.d.ts:1398

      +

      Defined in node_modules/@types/react/index.d.ts:1400


      Optional onKeyPressCapture#

      onKeyPressCapture? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyPressCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1399

      +

      Defined in node_modules/@types/react/index.d.ts:1401


      Optional onKeyUp#

      onKeyUp? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyUp

      -

      Defined in node_modules/@types/react/index.d.ts:1400

      +

      Defined in node_modules/@types/react/index.d.ts:1402


      Optional onKeyUpCapture#

      onKeyUpCapture? : KeyboardEventHandler‹any›

      Inherited from PageLayoutProps.onKeyUpCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1401

      +

      Defined in node_modules/@types/react/index.d.ts:1403


      Optional onLoad#

      onLoad? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoad

      -

      Defined in node_modules/@types/react/index.d.ts:1390

      +

      Defined in node_modules/@types/react/index.d.ts:1392


      Optional onLoadCapture#

      onLoadCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1391

      +

      Defined in node_modules/@types/react/index.d.ts:1393


      Optional onLoadStart#

      onLoadStart? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadStart

      -

      Defined in node_modules/@types/react/index.d.ts:1422

      +

      Defined in node_modules/@types/react/index.d.ts:1424


      Optional onLoadStartCapture#

      onLoadStartCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1423

      +

      Defined in node_modules/@types/react/index.d.ts:1425


      Optional onLoadedData#

      onLoadedData? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadedData

      -

      Defined in node_modules/@types/react/index.d.ts:1418

      +

      Defined in node_modules/@types/react/index.d.ts:1420


      Optional onLoadedDataCapture#

      onLoadedDataCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadedDataCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1419

      +

      Defined in node_modules/@types/react/index.d.ts:1421


      Optional onLoadedMetadata#

      onLoadedMetadata? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadedMetadata

      -

      Defined in node_modules/@types/react/index.d.ts:1420

      +

      Defined in node_modules/@types/react/index.d.ts:1422


      Optional onLoadedMetadataCapture#

      onLoadedMetadataCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onLoadedMetadataCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1421

      +

      Defined in node_modules/@types/react/index.d.ts:1423


      Optional onLostPointerCapture#

      onLostPointerCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onLostPointerCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1520

      +

      Defined in node_modules/@types/react/index.d.ts:1522


      Optional onLostPointerCaptureCapture#

      onLostPointerCaptureCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onLostPointerCaptureCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1521

      +

      Defined in node_modules/@types/react/index.d.ts:1523


      Optional onMouseDown#

      onMouseDown? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseDown

      -

      Defined in node_modules/@types/react/index.d.ts:1474

      +

      Defined in node_modules/@types/react/index.d.ts:1476


      Optional onMouseDownCapture#

      onMouseDownCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseDownCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1475

      +

      Defined in node_modules/@types/react/index.d.ts:1477


      Optional onMouseEnter#

      onMouseEnter? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseEnter

      -

      Defined in node_modules/@types/react/index.d.ts:1476

      +

      Defined in node_modules/@types/react/index.d.ts:1478


      Optional onMouseLeave#

      onMouseLeave? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseLeave

      -

      Defined in node_modules/@types/react/index.d.ts:1477

      +

      Defined in node_modules/@types/react/index.d.ts:1479


      Optional onMouseMove#

      onMouseMove? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseMove

      -

      Defined in node_modules/@types/react/index.d.ts:1478

      +

      Defined in node_modules/@types/react/index.d.ts:1480


      Optional onMouseMoveCapture#

      onMouseMoveCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseMoveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1479

      +

      Defined in node_modules/@types/react/index.d.ts:1481


      Optional onMouseOut#

      onMouseOut? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseOut

      -

      Defined in node_modules/@types/react/index.d.ts:1480

      +

      Defined in node_modules/@types/react/index.d.ts:1482


      Optional onMouseOutCapture#

      onMouseOutCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseOutCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1481

      +

      Defined in node_modules/@types/react/index.d.ts:1483


      Optional onMouseOver#

      onMouseOver? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseOver

      -

      Defined in node_modules/@types/react/index.d.ts:1482

      +

      Defined in node_modules/@types/react/index.d.ts:1484


      Optional onMouseOverCapture#

      onMouseOverCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseOverCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1483

      +

      Defined in node_modules/@types/react/index.d.ts:1485


      Optional onMouseUp#

      onMouseUp? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseUp

      -

      Defined in node_modules/@types/react/index.d.ts:1484

      +

      Defined in node_modules/@types/react/index.d.ts:1486


      Optional onMouseUpCapture#

      onMouseUpCapture? : MouseEventHandler‹any›

      Inherited from PageLayoutProps.onMouseUpCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1485

      +

      Defined in node_modules/@types/react/index.d.ts:1487


      Optional onPaste#

      onPaste? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onPaste

      -

      Defined in node_modules/@types/react/index.d.ts:1358

      +

      Defined in node_modules/@types/react/index.d.ts:1360


      Optional onPasteCapture#

      onPasteCapture? : ClipboardEventHandler‹any›

      Inherited from PageLayoutProps.onPasteCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1359

      +

      Defined in node_modules/@types/react/index.d.ts:1361


      Optional onPause#

      onPause? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPause

      -

      Defined in node_modules/@types/react/index.d.ts:1424

      +

      Defined in node_modules/@types/react/index.d.ts:1426


      Optional onPauseCapture#

      onPauseCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPauseCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1425

      +

      Defined in node_modules/@types/react/index.d.ts:1427


      Optional onPlay#

      onPlay? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPlay

      -

      Defined in node_modules/@types/react/index.d.ts:1426

      +

      Defined in node_modules/@types/react/index.d.ts:1428


      Optional onPlayCapture#

      onPlayCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPlayCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1427

      +

      Defined in node_modules/@types/react/index.d.ts:1429


      Optional onPlaying#

      onPlaying? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPlaying

      -

      Defined in node_modules/@types/react/index.d.ts:1428

      +

      Defined in node_modules/@types/react/index.d.ts:1430


      Optional onPlayingCapture#

      onPlayingCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onPlayingCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1429

      +

      Defined in node_modules/@types/react/index.d.ts:1431


      Optional onPointerCancel#

      onPointerCancel? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerCancel

      -

      Defined in node_modules/@types/react/index.d.ts:1508

      +

      Defined in node_modules/@types/react/index.d.ts:1510


      Optional onPointerCancelCapture#

      onPointerCancelCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerCancelCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1509

      +

      Defined in node_modules/@types/react/index.d.ts:1511


      Optional onPointerDown#

      onPointerDown? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerDown

      -

      Defined in node_modules/@types/react/index.d.ts:1502

      +

      Defined in node_modules/@types/react/index.d.ts:1504


      Optional onPointerDownCapture#

      onPointerDownCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerDownCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1503

      +

      Defined in node_modules/@types/react/index.d.ts:1505


      Optional onPointerEnter#

      onPointerEnter? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerEnter

      -

      Defined in node_modules/@types/react/index.d.ts:1510

      +

      Defined in node_modules/@types/react/index.d.ts:1512


      Optional onPointerEnterCapture#

      onPointerEnterCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerEnterCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1511

      +

      Defined in node_modules/@types/react/index.d.ts:1513


      Optional onPointerLeave#

      onPointerLeave? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerLeave

      -

      Defined in node_modules/@types/react/index.d.ts:1512

      +

      Defined in node_modules/@types/react/index.d.ts:1514


      Optional onPointerLeaveCapture#

      onPointerLeaveCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerLeaveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1513

      +

      Defined in node_modules/@types/react/index.d.ts:1515


      Optional onPointerMove#

      onPointerMove? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerMove

      -

      Defined in node_modules/@types/react/index.d.ts:1504

      +

      Defined in node_modules/@types/react/index.d.ts:1506


      Optional onPointerMoveCapture#

      onPointerMoveCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerMoveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1505

      +

      Defined in node_modules/@types/react/index.d.ts:1507


      Optional onPointerOut#

      onPointerOut? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerOut

      -

      Defined in node_modules/@types/react/index.d.ts:1516

      +

      Defined in node_modules/@types/react/index.d.ts:1518


      Optional onPointerOutCapture#

      onPointerOutCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerOutCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1517

      +

      Defined in node_modules/@types/react/index.d.ts:1519


      Optional onPointerOver#

      onPointerOver? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerOver

      -

      Defined in node_modules/@types/react/index.d.ts:1514

      +

      Defined in node_modules/@types/react/index.d.ts:1516


      Optional onPointerOverCapture#

      onPointerOverCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerOverCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1515

      +

      Defined in node_modules/@types/react/index.d.ts:1517


      Optional onPointerUp#

      onPointerUp? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerUp

      -

      Defined in node_modules/@types/react/index.d.ts:1506

      +

      Defined in node_modules/@types/react/index.d.ts:1508


      Optional onPointerUpCapture#

      onPointerUpCapture? : PointerEventHandler‹any›

      Inherited from PageLayoutProps.onPointerUpCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1507

      +

      Defined in node_modules/@types/react/index.d.ts:1509


      Optional onProgress#

      onProgress? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onProgress

      -

      Defined in node_modules/@types/react/index.d.ts:1430

      +

      Defined in node_modules/@types/react/index.d.ts:1432


      Optional onProgressCapture#

      onProgressCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onProgressCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1431

      +

      Defined in node_modules/@types/react/index.d.ts:1433


      Optional onRateChange#

      onRateChange? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onRateChange

      -

      Defined in node_modules/@types/react/index.d.ts:1432

      +

      Defined in node_modules/@types/react/index.d.ts:1434


      Optional onRateChangeCapture#

      onRateChangeCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onRateChangeCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1433

      +

      Defined in node_modules/@types/react/index.d.ts:1435


      Optional onReset#

      onReset? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onReset

      -

      Defined in node_modules/@types/react/index.d.ts:1382

      +

      Defined in node_modules/@types/react/index.d.ts:1384


      Optional onResetCapture#

      onResetCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onResetCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1383

      +

      Defined in node_modules/@types/react/index.d.ts:1385


      Optional onScroll#

      onScroll? : UIEventHandler‹any›

      Inherited from PageLayoutProps.onScroll

      -

      Defined in node_modules/@types/react/index.d.ts:1524

      +

      Defined in node_modules/@types/react/index.d.ts:1526


      Optional onScrollCapture#

      onScrollCapture? : UIEventHandler‹any›

      Inherited from PageLayoutProps.onScrollCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1525

      +

      Defined in node_modules/@types/react/index.d.ts:1527


      Optional onSeeked#

      onSeeked? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSeeked

      -

      Defined in node_modules/@types/react/index.d.ts:1434

      +

      Defined in node_modules/@types/react/index.d.ts:1436


      Optional onSeekedCapture#

      onSeekedCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSeekedCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1435

      +

      Defined in node_modules/@types/react/index.d.ts:1437


      Optional onSeeking#

      onSeeking? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSeeking

      -

      Defined in node_modules/@types/react/index.d.ts:1436

      +

      Defined in node_modules/@types/react/index.d.ts:1438


      Optional onSeekingCapture#

      onSeekingCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSeekingCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1437

      +

      Defined in node_modules/@types/react/index.d.ts:1439


      Optional onSelect#

      onSelect? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSelect

      -

      Defined in node_modules/@types/react/index.d.ts:1488

      +

      Defined in node_modules/@types/react/index.d.ts:1490


      Optional onSelectCapture#

      onSelectCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSelectCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1489

      +

      Defined in node_modules/@types/react/index.d.ts:1491


      Optional onStalled#

      onStalled? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onStalled

      -

      Defined in node_modules/@types/react/index.d.ts:1438

      +

      Defined in node_modules/@types/react/index.d.ts:1440


      Optional onStalledCapture#

      onStalledCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onStalledCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1439

      +

      Defined in node_modules/@types/react/index.d.ts:1441


      Optional onSubmit#

      onSubmit? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onSubmit

      -

      Defined in node_modules/@types/react/index.d.ts:1384

      +

      Defined in node_modules/@types/react/index.d.ts:1386


      Optional onSubmitCapture#

      onSubmitCapture? : FormEventHandler‹any›

      Inherited from PageLayoutProps.onSubmitCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1385

      +

      Defined in node_modules/@types/react/index.d.ts:1387


      Optional onSuspend#

      onSuspend? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSuspend

      -

      Defined in node_modules/@types/react/index.d.ts:1440

      +

      Defined in node_modules/@types/react/index.d.ts:1442


      Optional onSuspendCapture#

      onSuspendCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onSuspendCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1441

      +

      Defined in node_modules/@types/react/index.d.ts:1443


      Optional onTimeUpdate#

      onTimeUpdate? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onTimeUpdate

      -

      Defined in node_modules/@types/react/index.d.ts:1442

      +

      Defined in node_modules/@types/react/index.d.ts:1444


      Optional onTimeUpdateCapture#

      onTimeUpdateCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onTimeUpdateCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1443

      +

      Defined in node_modules/@types/react/index.d.ts:1445


      Optional onTouchCancel#

      onTouchCancel? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchCancel

      -

      Defined in node_modules/@types/react/index.d.ts:1492

      +

      Defined in node_modules/@types/react/index.d.ts:1494


      Optional onTouchCancelCapture#

      onTouchCancelCapture? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchCancelCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1493

      +

      Defined in node_modules/@types/react/index.d.ts:1495


      Optional onTouchEnd#

      onTouchEnd? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1494

      +

      Defined in node_modules/@types/react/index.d.ts:1496


      Optional onTouchEndCapture#

      onTouchEndCapture? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1495

      +

      Defined in node_modules/@types/react/index.d.ts:1497


      Optional onTouchMove#

      onTouchMove? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchMove

      -

      Defined in node_modules/@types/react/index.d.ts:1496

      +

      Defined in node_modules/@types/react/index.d.ts:1498


      Optional onTouchMoveCapture#

      onTouchMoveCapture? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchMoveCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1497

      +

      Defined in node_modules/@types/react/index.d.ts:1499


      Optional onTouchStart#

      onTouchStart? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchStart

      -

      Defined in node_modules/@types/react/index.d.ts:1498

      +

      Defined in node_modules/@types/react/index.d.ts:1500


      Optional onTouchStartCapture#

      onTouchStartCapture? : TouchEventHandler‹any›

      Inherited from PageLayoutProps.onTouchStartCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1499

      +

      Defined in node_modules/@types/react/index.d.ts:1501


      Optional onTransitionEnd#

      onTransitionEnd? : TransitionEventHandler‹any›

      Inherited from PageLayoutProps.onTransitionEnd

      -

      Defined in node_modules/@types/react/index.d.ts:1540

      +

      Defined in node_modules/@types/react/index.d.ts:1542


      Optional onTransitionEndCapture#

      onTransitionEndCapture? : TransitionEventHandler‹any›

      Inherited from PageLayoutProps.onTransitionEndCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1541

      +

      Defined in node_modules/@types/react/index.d.ts:1543


      Optional onVolumeChange#

      onVolumeChange? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onVolumeChange

      -

      Defined in node_modules/@types/react/index.d.ts:1444

      +

      Defined in node_modules/@types/react/index.d.ts:1446


      Optional onVolumeChangeCapture#

      onVolumeChangeCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onVolumeChangeCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1445

      +

      Defined in node_modules/@types/react/index.d.ts:1447


      Optional onWaiting#

      onWaiting? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onWaiting

      -

      Defined in node_modules/@types/react/index.d.ts:1446

      +

      Defined in node_modules/@types/react/index.d.ts:1448


      Optional onWaitingCapture#

      onWaitingCapture? : ReactEventHandler‹any›

      Inherited from PageLayoutProps.onWaitingCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1447

      +

      Defined in node_modules/@types/react/index.d.ts:1449


      Optional onWheel#

      onWheel? : WheelEventHandler‹any›

      Inherited from PageLayoutProps.onWheel

      -

      Defined in node_modules/@types/react/index.d.ts:1528

      +

      Defined in node_modules/@types/react/index.d.ts:1530


      Optional onWheelCapture#

      onWheelCapture? : WheelEventHandler‹any›

      Inherited from PageLayoutProps.onWheelCapture

      -

      Defined in node_modules/@types/react/index.d.ts:1529

      +

      Defined in node_modules/@types/react/index.d.ts:1531


      Optional provideBackButtonNavigation#

      provideBackButtonNavigation? : boolean

      -

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

      +

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


      Optional showOnTop#

      showOnTop? : boolean

      -

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

      +

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

      diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html index 8770b4c9bd..7caecf5a6d 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -942,23 +942,23 @@

      Properties#

      Optional asButtons#

      asButtons? : boolean

      -

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

      +

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


      Optional className#

      className? : any

      -

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

      +

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


      Optional disabled#

      disabled? : boolean

      -

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

      +

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


      Optional value#

      value? : any

      -

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

      +

      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

      +

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

      Parameters:

      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 5516e8edff..a85bff11f2 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -904,11 +904,11 @@

      Properties#

      Optional label#

      label? : React.ReactNode

      -

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

      +

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


      value#

      value: T

      -

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

      +

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

      diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html index e32628c24a..746d643432 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -1540,7 +1540,7 @@

      Optional autoConvertOptions#

      autoConvertOptions? : boolean

      -

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

      +

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


      Optional autoFocus#

      autoFocus? : boolean

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

      Optional isCreatable#

      isCreatable? : boolean

      -

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

      +

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


      Optional isDisabled#

      isDisabled? : boolean

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

      Optional menuClass#

      menuClass? : string

      -

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

      +

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


      Optional menuIsOpen#

      menuIsOpen? : boolean

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

      Optional themeName#

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

      -

      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 a4700d2631..5030e0a212 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -919,11 +919,11 @@

      Properties#

      Optional className#

      className? : string

      -

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

      +

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

      Methods#

      Optional onChange#

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

      -

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

      +

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

      Parameters:

      diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html index 99542f7790..48618f27c5 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -3793,244 +3793,244 @@

      Optional about#

      about? : string

      Inherited from ButtonProps.about

      -

      Defined in node_modules/@types/react/index.d.ts:1775

      +

      Defined in node_modules/@types/react/index.d.ts:1777


      Optional accept#

      accept? : string

      Inherited from LineProgressProps.accept

      -

      Defined in node_modules/@types/react/index.d.ts:1813

      +

      Defined in node_modules/@types/react/index.d.ts:1815


      Optional acceptCharset#

      acceptCharset? : string

      Inherited from LineProgressProps.acceptCharset

      -

      Defined in node_modules/@types/react/index.d.ts:1814

      +

      Defined in node_modules/@types/react/index.d.ts:1816


      Optional accessKey#

      accessKey? : string

      Inherited from ButtonProps.accessKey

      -

      Defined in node_modules/@types/react/index.d.ts:1751

      +

      Defined in node_modules/@types/react/index.d.ts:1753


      Optional action#

      action? : string

      Inherited from LineProgressProps.action

      -

      Defined in node_modules/@types/react/index.d.ts:1815

      +

      Defined in node_modules/@types/react/index.d.ts:1817


      Optional allowFullScreen#

      allowFullScreen? : boolean

      Inherited from LineProgressProps.allowFullScreen

      -

      Defined in node_modules/@types/react/index.d.ts:1816

      +

      Defined in node_modules/@types/react/index.d.ts:1818


      Optional allowTransparency#

      allowTransparency? : boolean

      Inherited from LineProgressProps.allowTransparency

      -

      Defined in node_modules/@types/react/index.d.ts:1817

      +

      Defined in node_modules/@types/react/index.d.ts:1819


      Optional alt#

      alt? : string

      Inherited from LineProgressProps.alt

      -

      Defined in node_modules/@types/react/index.d.ts:1818

      +

      Defined in node_modules/@types/react/index.d.ts:1820


      Optional aria-activedescendant#

      aria-activedescendant? : string

      Inherited from ButtonProps.aria-activedescendant

      -

      Defined in node_modules/@types/react/index.d.ts:1558

      +

      Defined in node_modules/@types/react/index.d.ts:1560

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1562

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1567

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1569

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1574

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1579

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1584

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1589

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1594

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1596

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1601

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1606

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1611

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1616

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1621

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1623

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1628

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1633

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1635

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1640

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1645

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1647

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1652

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1657

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1659

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1661

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1663

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1665

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1667

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1669

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1675

      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.

      @@ -4038,263 +4038,263 @@ between DOM elements where the DOM hierarchy cannot be used to represent the rel

      Optional aria-placeholder#

      aria-placeholder? : string

      Inherited from ButtonProps.aria-placeholder

      -

      Defined in node_modules/@types/react/index.d.ts:1678

      +

      Defined in node_modules/@types/react/index.d.ts:1680

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1685

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1690

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1695

      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"

      +

      aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

      Inherited from ButtonProps.aria-relevant

      -

      Defined in node_modules/@types/react/index.d.ts:1698

      +

      Defined in node_modules/@types/react/index.d.ts:1700

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1702

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1704

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1709

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1714

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1719

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1724

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1729

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1731

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1733

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1735

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1740

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1742

      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

      +

      Defined in node_modules/@types/react/index.d.ts:1821


      Optional async#

      async? : boolean

      Inherited from LineProgressProps.async

      -

      Defined in node_modules/@types/react/index.d.ts:1820

      +

      Defined in node_modules/@types/react/index.d.ts:1822


      Optional autoCapitalize#

      autoCapitalize? : string

      Inherited from ButtonProps.autoCapitalize

      -

      Defined in node_modules/@types/react/index.d.ts:1785

      +

      Defined in node_modules/@types/react/index.d.ts:1787


      Optional autoComplete#

      autoComplete? : string

      Inherited from LineProgressProps.autoComplete

      -

      Defined in node_modules/@types/react/index.d.ts:1821

      +

      Defined in node_modules/@types/react/index.d.ts:1823


      Optional autoCorrect#

      autoCorrect? : string

      Inherited from ButtonProps.autoCorrect

      -

      Defined in node_modules/@types/react/index.d.ts:1786

      +

      Defined in node_modules/@types/react/index.d.ts:1788


      Optional autoFocus#

      autoFocus? : boolean

      Inherited from LineProgressProps.autoFocus

      -

      Defined in node_modules/@types/react/index.d.ts:1822

      +

      Defined in node_modules/@types/react/index.d.ts:1824


      Optional autoPlay#

      autoPlay? : boolean

      Inherited from LineProgressProps.autoPlay

      -

      Defined in node_modules/@types/react/index.d.ts:1823

      +

      Defined in node_modules/@types/react/index.d.ts:1825


      Optional autoSave#

      autoSave? : string

      Inherited from ButtonProps.autoSave

      -

      Defined in node_modules/@types/react/index.d.ts:1787

      +

      Defined in node_modules/@types/react/index.d.ts:1789


      Optional capture#

      capture? : boolean | string

      Inherited from LineProgressProps.capture

      -

      Defined in node_modules/@types/react/index.d.ts:1824

      +

      Defined in node_modules/@types/react/index.d.ts:1826


      Optional cellPadding#

      cellPadding? : number | string

      Inherited from LineProgressProps.cellPadding

      -

      Defined in node_modules/@types/react/index.d.ts:1825

      +

      Defined in node_modules/@types/react/index.d.ts:1827


      Optional cellSpacing#

      cellSpacing? : number | string

      Inherited from LineProgressProps.cellSpacing

      -

      Defined in node_modules/@types/react/index.d.ts:1826

      +

      Defined in node_modules/@types/react/index.d.ts:1828


      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

      Inherited from LineProgressProps.challenge

      -

      Defined in node_modules/@types/react/index.d.ts:1828

      +

      Defined in node_modules/@types/react/index.d.ts:1830


      Optional charSet#

      charSet? : string

      Inherited from LineProgressProps.charSet

      -

      Defined in node_modules/@types/react/index.d.ts:1827

      +

      Defined in node_modules/@types/react/index.d.ts:1829


      Optional checked#

      checked? : boolean

      Inherited from LineProgressProps.checked

      -

      Defined in node_modules/@types/react/index.d.ts:1829

      +

      Defined in node_modules/@types/react/index.d.ts:1831


      Optional children#

      children? : ReactNode

      Inherited from PageLayoutProps.children

      -

      Defined in node_modules/@types/react/index.d.ts:1348

      +

      Defined in node_modules/@types/react/index.d.ts:1350


      Optional cite#

      cite? : string

      Inherited from LineProgressProps.cite

      -

      Defined in node_modules/@types/react/index.d.ts:1830

      +

      Defined in node_modules/@types/react/index.d.ts:1832


      Optional classID#

      classID? : string

      Inherited from LineProgressProps.classID

      -

      Defined in node_modules/@types/react/index.d.ts:1831

      +

      Defined in node_modules/@types/react/index.d.ts:1833


      Optional className#

      className? : string

      Inherited from ButtonProps.className

      -

      Defined in node_modules/@types/react/index.d.ts:1752

      +

      Defined in node_modules/@types/react/index.d.ts:1754


      Optional colSpan#

      colSpan? : number

      Inherited from LineProgressProps.colSpan

      -

      Defined in node_modules/@types/react/index.d.ts:1833

      +

      Defined in node_modules/@types/react/index.d.ts:1835


      Optional color#

      color? : string

      Inherited from ButtonProps.color

      -

      Defined in node_modules/@types/react/index.d.ts:1788

      +

      Defined in node_modules/@types/react/index.d.ts:1790


      Optional cols#

      cols? : number

      Inherited from LineProgressProps.cols

      -

      Defined in node_modules/@types/react/index.d.ts:1832

      +

      Defined in node_modules/@types/react/index.d.ts:1834


      Optional content#

      content? : string

      Inherited from LineProgressProps.content

      -

      Defined in node_modules/@types/react/index.d.ts:1834

      +

      Defined in node_modules/@types/react/index.d.ts:1836


      Optional contentEditable#

      contentEditable? : Booleanish | "inherit"

      Inherited from ButtonProps.contentEditable

      -

      Defined in node_modules/@types/react/index.d.ts:1753

      +

      Defined in node_modules/@types/react/index.d.ts:1755


      Optional contextMenu#

      contextMenu? : string

      Inherited from ButtonProps.contextMenu

      -

      Defined in node_modules/@types/react/index.d.ts:1754

      +

      Defined in node_modules/@types/react/index.d.ts:1756


      Optional controls#

      controls? : boolean

      Inherited from LineProgressProps.controls

      -

      Defined in node_modules/@types/react/index.d.ts:1835

      +

      Defined in node_modules/@types/react/index.d.ts:1837


      Optional coords#

      coords? : string

      Inherited from LineProgressProps.coords

      -

      Defined in node_modules/@types/react/index.d.ts:1836

      +

      Defined in node_modules/@types/react/index.d.ts:1838


      Optional crossOrigin#

      crossOrigin? : string

      Inherited from LineProgressProps.crossOrigin

      -

      Defined in node_modules/@types/react/index.d.ts:1837

      +

      Defined in node_modules/@types/react/index.d.ts:1839


      Optional dangerouslySetInnerHTML#

      dangerouslySetInnerHTML? : object

      Inherited from PageLayoutProps.dangerouslySetInnerHTML

      -

      Defined in node_modules/@types/react/index.d.ts:1349

      +

      Defined in node_modules/@types/react/index.d.ts:1351

      Type declaration:

      • __html: string
      • @@ -4303,1396 +4303,1396 @@ A hint could be a sample value or a brief description of the expected format.

        Optional data#

        data? : string

        Inherited from LineProgressProps.data

        -

        Defined in node_modules/@types/react/index.d.ts:1838

        +

        Defined in node_modules/@types/react/index.d.ts:1840


        Optional datatype#

        datatype? : string

        Inherited from ButtonProps.datatype

        -

        Defined in node_modules/@types/react/index.d.ts:1776

        +

        Defined in node_modules/@types/react/index.d.ts:1778


        Optional dateTime#

        dateTime? : string

        Inherited from LineProgressProps.dateTime

        -

        Defined in node_modules/@types/react/index.d.ts:1839

        +

        Defined in node_modules/@types/react/index.d.ts:1841


        Optional default#

        default? : boolean

        Inherited from LineProgressProps.default

        -

        Defined in node_modules/@types/react/index.d.ts:1840

        +

        Defined in node_modules/@types/react/index.d.ts:1842


        Optional defaultChecked#

        defaultChecked? : boolean

        Inherited from ButtonProps.defaultChecked

        -

        Defined in node_modules/@types/react/index.d.ts:1745

        +

        Defined in node_modules/@types/react/index.d.ts:1747


        Optional defaultValue#

        -

        defaultValue? : string | number | string[]

        +

        defaultValue? : string | number | ReadonlyArray‹string›

        Inherited from ButtonProps.defaultValue

        -

        Defined in node_modules/@types/react/index.d.ts:1746

        +

        Defined in node_modules/@types/react/index.d.ts:1748


        Optional defer#

        defer? : boolean

        Inherited from LineProgressProps.defer

        -

        Defined in node_modules/@types/react/index.d.ts:1841

        +

        Defined in node_modules/@types/react/index.d.ts:1843


        Optional dir#

        dir? : string

        Inherited from ButtonProps.dir

        -

        Defined in node_modules/@types/react/index.d.ts:1755

        +

        Defined in node_modules/@types/react/index.d.ts:1757


        Optional disabled#

        disabled? : boolean

        Inherited from LineProgressProps.disabled

        -

        Defined in node_modules/@types/react/index.d.ts:1842

        +

        Defined in node_modules/@types/react/index.d.ts:1844


        Optional download#

        download? : any

        Inherited from LineProgressProps.download

        -

        Defined in node_modules/@types/react/index.d.ts:1843

        +

        Defined in node_modules/@types/react/index.d.ts:1845


        Optional draggable#

        draggable? : Booleanish

        Inherited from ButtonProps.draggable

        -

        Defined in node_modules/@types/react/index.d.ts:1756

        +

        Defined in node_modules/@types/react/index.d.ts:1758


        Optional encType#

        encType? : string

        Inherited from LineProgressProps.encType

        -

        Defined in node_modules/@types/react/index.d.ts:1844

        +

        Defined in node_modules/@types/react/index.d.ts:1846


        Optional form#

        form? : string

        Inherited from LineProgressProps.form

        -

        Defined in node_modules/@types/react/index.d.ts:1845

        +

        Defined in node_modules/@types/react/index.d.ts:1847


        Optional formAction#

        formAction? : string

        Inherited from LineProgressProps.formAction

        -

        Defined in node_modules/@types/react/index.d.ts:1846

        +

        Defined in node_modules/@types/react/index.d.ts:1848


        Optional formEncType#

        formEncType? : string

        Inherited from LineProgressProps.formEncType

        -

        Defined in node_modules/@types/react/index.d.ts:1847

        +

        Defined in node_modules/@types/react/index.d.ts:1849


        Optional formMethod#

        formMethod? : string

        Inherited from LineProgressProps.formMethod

        -

        Defined in node_modules/@types/react/index.d.ts:1848

        +

        Defined in node_modules/@types/react/index.d.ts:1850


        Optional formNoValidate#

        formNoValidate? : boolean

        Inherited from LineProgressProps.formNoValidate

        -

        Defined in node_modules/@types/react/index.d.ts:1849

        +

        Defined in node_modules/@types/react/index.d.ts:1851


        Optional formTarget#

        formTarget? : string

        Inherited from LineProgressProps.formTarget

        -

        Defined in node_modules/@types/react/index.d.ts:1850

        +

        Defined in node_modules/@types/react/index.d.ts:1852


        Optional frameBorder#

        frameBorder? : number | string

        Inherited from LineProgressProps.frameBorder

        -

        Defined in node_modules/@types/react/index.d.ts:1851

        +

        Defined in node_modules/@types/react/index.d.ts:1853


        Optional headers#

        headers? : string

        Inherited from LineProgressProps.headers

        -

        Defined in node_modules/@types/react/index.d.ts:1852

        +

        Defined in node_modules/@types/react/index.d.ts:1854


        Optional height#

        height? : number | string

        Inherited from LineProgressProps.height

        -

        Defined in node_modules/@types/react/index.d.ts:1853

        +

        Defined in node_modules/@types/react/index.d.ts:1855


        Optional hidden#

        hidden? : boolean

        Inherited from IconProps.hidden

        -

        Defined in node_modules/@types/react/index.d.ts:1757

        +

        Defined in node_modules/@types/react/index.d.ts:1759


        Optional high#

        high? : number

        Inherited from LineProgressProps.high

        -

        Defined in node_modules/@types/react/index.d.ts:1854

        +

        Defined in node_modules/@types/react/index.d.ts:1856


        Optional href#

        href? : string

        Inherited from LineProgressProps.href

        -

        Defined in node_modules/@types/react/index.d.ts:1855

        +

        Defined in node_modules/@types/react/index.d.ts:1857


        Optional hrefLang#

        hrefLang? : string

        Inherited from LineProgressProps.hrefLang

        -

        Defined in node_modules/@types/react/index.d.ts:1856

        +

        Defined in node_modules/@types/react/index.d.ts:1858


        Optional htmlFor#

        htmlFor? : string

        Inherited from LineProgressProps.htmlFor

        -

        Defined in node_modules/@types/react/index.d.ts:1857

        +

        Defined in node_modules/@types/react/index.d.ts:1859


        Optional httpEquiv#

        httpEquiv? : string

        Inherited from LineProgressProps.httpEquiv

        -

        Defined in node_modules/@types/react/index.d.ts:1858

        +

        Defined in node_modules/@types/react/index.d.ts:1860


        Optional id#

        id? : string

        Inherited from ButtonProps.id

        -

        Defined in node_modules/@types/react/index.d.ts:1758

        +

        Defined in node_modules/@types/react/index.d.ts:1760


        Optional inlist#

        inlist? : any

        Inherited from ButtonProps.inlist

        -

        Defined in node_modules/@types/react/index.d.ts:1777

        +

        Defined in node_modules/@types/react/index.d.ts:1779


        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

        +

        Defined in node_modules/@types/react/index.d.ts:1805

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1861


        Optional is#

        is? : string

        Inherited from ButtonProps.is

        -

        Defined in node_modules/@types/react/index.d.ts:1808

        +

        Defined in node_modules/@types/react/index.d.ts:1810

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1794


        Optional itemProp#

        itemProp? : string

        Inherited from ButtonProps.itemProp

        -

        Defined in node_modules/@types/react/index.d.ts:1789

        +

        Defined in node_modules/@types/react/index.d.ts:1791


        Optional itemRef#

        itemRef? : string

        Inherited from ButtonProps.itemRef

        -

        Defined in node_modules/@types/react/index.d.ts:1793

        +

        Defined in node_modules/@types/react/index.d.ts:1795


        Optional itemScope#

        itemScope? : boolean

        Inherited from ButtonProps.itemScope

        -

        Defined in node_modules/@types/react/index.d.ts:1790

        +

        Defined in node_modules/@types/react/index.d.ts:1792


        Optional itemType#

        itemType? : string

        Inherited from ButtonProps.itemType

        -

        Defined in node_modules/@types/react/index.d.ts:1791

        +

        Defined in node_modules/@types/react/index.d.ts:1793


        Optional key#

        -

        key? : Key

        +

        key? : Key | null

        Inherited from LineProgressProps.key

        -

        Defined in node_modules/@types/react/index.d.ts:139

        +

        Defined in node_modules/@types/react/index.d.ts:137


        Optional keyParams#

        keyParams? : string

        Inherited from LineProgressProps.keyParams

        -

        Defined in node_modules/@types/react/index.d.ts:1860

        +

        Defined in node_modules/@types/react/index.d.ts:1862


        Optional keyType#

        keyType? : string

        Inherited from LineProgressProps.keyType

        -

        Defined in node_modules/@types/react/index.d.ts:1861

        +

        Defined in node_modules/@types/react/index.d.ts:1863


        Optional kind#

        kind? : string

        Inherited from LineProgressProps.kind

        -

        Defined in node_modules/@types/react/index.d.ts:1862

        +

        Defined in node_modules/@types/react/index.d.ts:1864


        Optional label#

        label? : string

        Inherited from LineProgressProps.label

        -

        Defined in node_modules/@types/react/index.d.ts:1863

        +

        Defined in node_modules/@types/react/index.d.ts:1865


        Optional lang#

        lang? : string

        Inherited from ButtonProps.lang

        -

        Defined in node_modules/@types/react/index.d.ts:1759

        +

        Defined in node_modules/@types/react/index.d.ts:1761


        Optional list#

        list? : string

        Inherited from LineProgressProps.list

        -

        Defined in node_modules/@types/react/index.d.ts:1864

        +

        Defined in node_modules/@types/react/index.d.ts:1866


        Optional loop#

        loop? : boolean

        Inherited from LineProgressProps.loop

        -

        Defined in node_modules/@types/react/index.d.ts:1865

        +

        Defined in node_modules/@types/react/index.d.ts:1867


        Optional low#

        low? : number

        Inherited from LineProgressProps.low

        -

        Defined in node_modules/@types/react/index.d.ts:1866

        +

        Defined in node_modules/@types/react/index.d.ts:1868


        Optional manifest#

        manifest? : string

        Inherited from LineProgressProps.manifest

        -

        Defined in node_modules/@types/react/index.d.ts:1867

        +

        Defined in node_modules/@types/react/index.d.ts:1869


        Optional marginHeight#

        marginHeight? : number

        Inherited from LineProgressProps.marginHeight

        -

        Defined in node_modules/@types/react/index.d.ts:1868

        +

        Defined in node_modules/@types/react/index.d.ts:1870


        Optional marginWidth#

        marginWidth? : number

        Inherited from LineProgressProps.marginWidth

        -

        Defined in node_modules/@types/react/index.d.ts:1869

        +

        Defined in node_modules/@types/react/index.d.ts:1871


        Optional max#

        max? : number | string

        Inherited from MenuItemProps.max

        -

        Defined in node_modules/@types/react/index.d.ts:1870

        +

        Defined in node_modules/@types/react/index.d.ts:1872


        Optional maxLength#

        maxLength? : number

        Inherited from LineProgressProps.maxLength

        -

        Defined in node_modules/@types/react/index.d.ts:1871

        +

        Defined in node_modules/@types/react/index.d.ts:1873


        Optional media#

        media? : string

        Inherited from LineProgressProps.media

        -

        Defined in node_modules/@types/react/index.d.ts:1872

        +

        Defined in node_modules/@types/react/index.d.ts:1874


        Optional mediaGroup#

        mediaGroup? : string

        Inherited from LineProgressProps.mediaGroup

        -

        Defined in node_modules/@types/react/index.d.ts:1873

        +

        Defined in node_modules/@types/react/index.d.ts:1875


        Optional method#

        method? : string

        Inherited from LineProgressProps.method

        -

        Defined in node_modules/@types/react/index.d.ts:1874

        +

        Defined in node_modules/@types/react/index.d.ts:1876


        Optional min#

        min? : number | string

        Inherited from MenuItemProps.min

        -

        Defined in node_modules/@types/react/index.d.ts:1875

        +

        Defined in node_modules/@types/react/index.d.ts:1877


        Optional minLength#

        minLength? : number

        Inherited from LineProgressProps.minLength

        -

        Defined in node_modules/@types/react/index.d.ts:1876

        +

        Defined in node_modules/@types/react/index.d.ts:1878


        Optional multiple#

        multiple? : boolean

        Inherited from LineProgressProps.multiple

        -

        Defined in node_modules/@types/react/index.d.ts:1877

        +

        Defined in node_modules/@types/react/index.d.ts:1879


        Optional muted#

        muted? : boolean

        Inherited from LineProgressProps.muted

        -

        Defined in node_modules/@types/react/index.d.ts:1878

        +

        Defined in node_modules/@types/react/index.d.ts:1880


        Optional name#

        name? : string

        Inherited from LineProgressProps.name

        -

        Defined in node_modules/@types/react/index.d.ts:1879

        +

        Defined in node_modules/@types/react/index.d.ts:1881


        Optional noValidate#

        noValidate? : boolean

        Inherited from LineProgressProps.noValidate

        -

        Defined in node_modules/@types/react/index.d.ts:1881

        +

        Defined in node_modules/@types/react/index.d.ts:1883


        Optional nonce#

        nonce? : string

        Inherited from LineProgressProps.nonce

        -

        Defined in node_modules/@types/react/index.d.ts:1880

        +

        Defined in node_modules/@types/react/index.d.ts:1882


        Optional onAbort#

        onAbort? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onAbort

        -

        Defined in node_modules/@types/react/index.d.ts:1404

        +

        Defined in node_modules/@types/react/index.d.ts:1406


        Optional onAbortCapture#

        onAbortCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onAbortCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1405

        +

        Defined in node_modules/@types/react/index.d.ts:1407


        Optional onAnimationEnd#

        onAnimationEnd? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1534

        +

        Defined in node_modules/@types/react/index.d.ts:1536


        Optional onAnimationEndCapture#

        onAnimationEndCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1535

        +

        Defined in node_modules/@types/react/index.d.ts:1537


        Optional onAnimationIteration#

        onAnimationIteration? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationIteration

        -

        Defined in node_modules/@types/react/index.d.ts:1536

        +

        Defined in node_modules/@types/react/index.d.ts:1538


        Optional onAnimationIterationCapture#

        onAnimationIterationCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationIterationCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1537

        +

        Defined in node_modules/@types/react/index.d.ts:1539


        Optional onAnimationStart#

        onAnimationStart? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationStart

        -

        Defined in node_modules/@types/react/index.d.ts:1532

        +

        Defined in node_modules/@types/react/index.d.ts:1534


        Optional onAnimationStartCapture#

        onAnimationStartCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1533

        +

        Defined in node_modules/@types/react/index.d.ts:1535


        Optional onAuxClick#

        onAuxClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onAuxClick

        -

        Defined in node_modules/@types/react/index.d.ts:1450

        +

        Defined in node_modules/@types/react/index.d.ts:1452


        Optional onAuxClickCapture#

        onAuxClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onAuxClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1451

        +

        Defined in node_modules/@types/react/index.d.ts:1453


        Optional onBeforeInput#

        onBeforeInput? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onBeforeInput

        -

        Defined in node_modules/@types/react/index.d.ts:1378

        +

        Defined in node_modules/@types/react/index.d.ts:1380


        Optional onBeforeInputCapture#

        onBeforeInputCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onBeforeInputCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1379

        +

        Defined in node_modules/@types/react/index.d.ts:1381


        Optional onBlur#

        onBlur? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onBlur

        -

        Defined in node_modules/@types/react/index.d.ts:1372

        +

        Defined in node_modules/@types/react/index.d.ts:1374


        Optional onBlurCapture#

        onBlurCapture? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onBlurCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1373

        +

        Defined in node_modules/@types/react/index.d.ts:1375


        Optional onCanPlay#

        onCanPlay? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlay

        -

        Defined in node_modules/@types/react/index.d.ts:1406

        +

        Defined in node_modules/@types/react/index.d.ts:1408


        Optional onCanPlayCapture#

        onCanPlayCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1407

        +

        Defined in node_modules/@types/react/index.d.ts:1409


        Optional onCanPlayThrough#

        onCanPlayThrough? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayThrough

        -

        Defined in node_modules/@types/react/index.d.ts:1408

        +

        Defined in node_modules/@types/react/index.d.ts:1410


        Optional onCanPlayThroughCapture#

        onCanPlayThroughCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayThroughCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1409

        +

        Defined in node_modules/@types/react/index.d.ts:1411


        Optional onChange#

        onChange? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onChange

        -

        Defined in node_modules/@types/react/index.d.ts:1376

        +

        Defined in node_modules/@types/react/index.d.ts:1378


        Optional onChangeCapture#

        onChangeCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1377

        +

        Defined in node_modules/@types/react/index.d.ts:1379


        Optional onClick#

        onClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onClick

        -

        Defined in node_modules/@types/react/index.d.ts:1452

        +

        Defined in node_modules/@types/react/index.d.ts:1454


        Optional onClickCapture#

        onClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1453

        +

        Defined in node_modules/@types/react/index.d.ts:1455


        Optional onCompositionEnd#

        onCompositionEnd? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1362

        +

        Defined in node_modules/@types/react/index.d.ts:1364


        Optional onCompositionEndCapture#

        onCompositionEndCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1363

        +

        Defined in node_modules/@types/react/index.d.ts:1365


        Optional onCompositionStart#

        onCompositionStart? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionStart

        -

        Defined in node_modules/@types/react/index.d.ts:1364

        +

        Defined in node_modules/@types/react/index.d.ts:1366


        Optional onCompositionStartCapture#

        onCompositionStartCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1365

        +

        Defined in node_modules/@types/react/index.d.ts:1367


        Optional onCompositionUpdate#

        onCompositionUpdate? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionUpdate

        -

        Defined in node_modules/@types/react/index.d.ts:1366

        +

        Defined in node_modules/@types/react/index.d.ts:1368


        Optional onCompositionUpdateCapture#

        onCompositionUpdateCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionUpdateCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1367

        +

        Defined in node_modules/@types/react/index.d.ts:1369


        Optional onContextMenu#

        onContextMenu? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onContextMenu

        -

        Defined in node_modules/@types/react/index.d.ts:1454

        +

        Defined in node_modules/@types/react/index.d.ts:1456


        Optional onContextMenuCapture#

        onContextMenuCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onContextMenuCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1455

        +

        Defined in node_modules/@types/react/index.d.ts:1457


        Optional onCopy#

        onCopy? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCopy

        -

        Defined in node_modules/@types/react/index.d.ts:1354

        +

        Defined in node_modules/@types/react/index.d.ts:1356


        Optional onCopyCapture#

        onCopyCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCopyCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1355

        +

        Defined in node_modules/@types/react/index.d.ts:1357


        Optional onCut#

        onCut? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCut

        -

        Defined in node_modules/@types/react/index.d.ts:1356

        +

        Defined in node_modules/@types/react/index.d.ts:1358


        Optional onCutCapture#

        onCutCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1357

        +

        Defined in node_modules/@types/react/index.d.ts:1359


        Optional onDoubleClick#

        onDoubleClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onDoubleClick

        -

        Defined in node_modules/@types/react/index.d.ts:1456

        +

        Defined in node_modules/@types/react/index.d.ts:1458


        Optional onDoubleClickCapture#

        onDoubleClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onDoubleClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1457

        +

        Defined in node_modules/@types/react/index.d.ts:1459


        Optional onDrag#

        onDrag? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDrag

        -

        Defined in node_modules/@types/react/index.d.ts:1458

        +

        Defined in node_modules/@types/react/index.d.ts:1460


        Optional onDragCapture#

        onDragCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1459

        +

        Defined in node_modules/@types/react/index.d.ts:1461


        Optional onDragEnd#

        onDragEnd? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1460

        +

        Defined in node_modules/@types/react/index.d.ts:1462


        Optional onDragEndCapture#

        onDragEndCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1461

        +

        Defined in node_modules/@types/react/index.d.ts:1463


        Optional onDragEnter#

        onDragEnter? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1462

        +

        Defined in node_modules/@types/react/index.d.ts:1464


        Optional onDragEnterCapture#

        onDragEnterCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnterCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1463

        +

        Defined in node_modules/@types/react/index.d.ts:1465


        Optional onDragExit#

        onDragExit? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragExit

        -

        Defined in node_modules/@types/react/index.d.ts:1464

        +

        Defined in node_modules/@types/react/index.d.ts:1466


        Optional onDragExitCapture#

        onDragExitCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragExitCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1465

        +

        Defined in node_modules/@types/react/index.d.ts:1467


        Optional onDragLeave#

        onDragLeave? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1466

        +

        Defined in node_modules/@types/react/index.d.ts:1468


        Optional onDragLeaveCapture#

        onDragLeaveCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragLeaveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1467

        +

        Defined in node_modules/@types/react/index.d.ts:1469


        Optional onDragOver#

        onDragOver? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragOver

        -

        Defined in node_modules/@types/react/index.d.ts:1468

        +

        Defined in node_modules/@types/react/index.d.ts:1470


        Optional onDragOverCapture#

        onDragOverCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1469

        +

        Defined in node_modules/@types/react/index.d.ts:1471


        Optional onDragStart#

        onDragStart? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragStart

        -

        Defined in node_modules/@types/react/index.d.ts:1470

        +

        Defined in node_modules/@types/react/index.d.ts:1472


        Optional onDragStartCapture#

        onDragStartCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1471

        +

        Defined in node_modules/@types/react/index.d.ts:1473


        Optional onDrop#

        onDrop? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDrop

        -

        Defined in node_modules/@types/react/index.d.ts:1472

        +

        Defined in node_modules/@types/react/index.d.ts:1474


        Optional onDropCapture#

        onDropCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDropCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1473

        +

        Defined in node_modules/@types/react/index.d.ts:1475


        Optional onDurationChange#

        onDurationChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onDurationChange

        -

        Defined in node_modules/@types/react/index.d.ts:1410

        +

        Defined in node_modules/@types/react/index.d.ts:1412


        Optional onDurationChangeCapture#

        onDurationChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onDurationChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1411

        +

        Defined in node_modules/@types/react/index.d.ts:1413


        Optional onEmptied#

        onEmptied? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEmptied

        -

        Defined in node_modules/@types/react/index.d.ts:1412

        +

        Defined in node_modules/@types/react/index.d.ts:1414


        Optional onEmptiedCapture#

        onEmptiedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEmptiedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1413

        +

        Defined in node_modules/@types/react/index.d.ts:1415


        Optional onEncrypted#

        onEncrypted? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEncrypted

        -

        Defined in node_modules/@types/react/index.d.ts:1414

        +

        Defined in node_modules/@types/react/index.d.ts:1416


        Optional onEncryptedCapture#

        onEncryptedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEncryptedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1415

        +

        Defined in node_modules/@types/react/index.d.ts:1417


        Optional onEnded#

        onEnded? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEnded

        -

        Defined in node_modules/@types/react/index.d.ts:1416

        +

        Defined in node_modules/@types/react/index.d.ts:1418


        Optional onEndedCapture#

        onEndedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEndedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1417

        +

        Defined in node_modules/@types/react/index.d.ts:1419


        Optional onError#

        onError? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onError

        -

        Defined in node_modules/@types/react/index.d.ts:1392

        +

        Defined in node_modules/@types/react/index.d.ts:1394


        Optional onErrorCapture#

        onErrorCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onErrorCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1393

        +

        Defined in node_modules/@types/react/index.d.ts:1395


        Optional onFocus#

        onFocus? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onFocus

        -

        Defined in node_modules/@types/react/index.d.ts:1370

        +

        Defined in node_modules/@types/react/index.d.ts:1372


        Optional onFocusCapture#

        onFocusCapture? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onFocusCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1371

        +

        Defined in node_modules/@types/react/index.d.ts:1373


        Optional onGotPointerCapture#

        onGotPointerCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onGotPointerCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1518

        +

        Defined in node_modules/@types/react/index.d.ts:1520


        Optional onGotPointerCaptureCapture#

        onGotPointerCaptureCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onGotPointerCaptureCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1519

        +

        Defined in node_modules/@types/react/index.d.ts:1521


        Optional onInput#

        onInput? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInput

        -

        Defined in node_modules/@types/react/index.d.ts:1380

        +

        Defined in node_modules/@types/react/index.d.ts:1382


        Optional onInputCapture#

        onInputCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInputCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1381

        +

        Defined in node_modules/@types/react/index.d.ts:1383


        Optional onInvalid#

        onInvalid? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInvalid

        -

        Defined in node_modules/@types/react/index.d.ts:1386

        +

        Defined in node_modules/@types/react/index.d.ts:1388


        Optional onInvalidCapture#

        onInvalidCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInvalidCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1387

        +

        Defined in node_modules/@types/react/index.d.ts:1389


        Optional onKeyDown#

        onKeyDown? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyDown

        -

        Defined in node_modules/@types/react/index.d.ts:1396

        +

        Defined in node_modules/@types/react/index.d.ts:1398


        Optional onKeyDownCapture#

        onKeyDownCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1397

        +

        Defined in node_modules/@types/react/index.d.ts:1399


        Optional onKeyPress#

        onKeyPress? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyPress

        -

        Defined in node_modules/@types/react/index.d.ts:1398

        +

        Defined in node_modules/@types/react/index.d.ts:1400


        Optional onKeyPressCapture#

        onKeyPressCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyPressCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1399

        +

        Defined in node_modules/@types/react/index.d.ts:1401


        Optional onKeyUp#

        onKeyUp? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyUp

        -

        Defined in node_modules/@types/react/index.d.ts:1400

        +

        Defined in node_modules/@types/react/index.d.ts:1402


        Optional onKeyUpCapture#

        onKeyUpCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1401

        +

        Defined in node_modules/@types/react/index.d.ts:1403


        Optional onLoad#

        onLoad? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoad

        -

        Defined in node_modules/@types/react/index.d.ts:1390

        +

        Defined in node_modules/@types/react/index.d.ts:1392


        Optional onLoadCapture#

        onLoadCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1391

        +

        Defined in node_modules/@types/react/index.d.ts:1393


        Optional onLoadStart#

        onLoadStart? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadStart

        -

        Defined in node_modules/@types/react/index.d.ts:1422

        +

        Defined in node_modules/@types/react/index.d.ts:1424


        Optional onLoadStartCapture#

        onLoadStartCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1423

        +

        Defined in node_modules/@types/react/index.d.ts:1425


        Optional onLoadedData#

        onLoadedData? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedData

        -

        Defined in node_modules/@types/react/index.d.ts:1418

        +

        Defined in node_modules/@types/react/index.d.ts:1420


        Optional onLoadedDataCapture#

        onLoadedDataCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedDataCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1419

        +

        Defined in node_modules/@types/react/index.d.ts:1421


        Optional onLoadedMetadata#

        onLoadedMetadata? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedMetadata

        -

        Defined in node_modules/@types/react/index.d.ts:1420

        +

        Defined in node_modules/@types/react/index.d.ts:1422


        Optional onLoadedMetadataCapture#

        onLoadedMetadataCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedMetadataCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1421

        +

        Defined in node_modules/@types/react/index.d.ts:1423


        Optional onLostPointerCapture#

        onLostPointerCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onLostPointerCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1520

        +

        Defined in node_modules/@types/react/index.d.ts:1522


        Optional onLostPointerCaptureCapture#

        onLostPointerCaptureCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onLostPointerCaptureCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1521

        +

        Defined in node_modules/@types/react/index.d.ts:1523


        Optional onMouseDown#

        onMouseDown? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseDown

        -

        Defined in node_modules/@types/react/index.d.ts:1474

        +

        Defined in node_modules/@types/react/index.d.ts:1476


        Optional onMouseDownCapture#

        onMouseDownCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1475

        +

        Defined in node_modules/@types/react/index.d.ts:1477


        Optional onMouseEnter#

        onMouseEnter? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1476

        +

        Defined in node_modules/@types/react/index.d.ts:1478


        Optional onMouseLeave#

        onMouseLeave? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1477

        +

        Defined in node_modules/@types/react/index.d.ts:1479


        Optional onMouseMove#

        onMouseMove? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseMove

        -

        Defined in node_modules/@types/react/index.d.ts:1478

        +

        Defined in node_modules/@types/react/index.d.ts:1480


        Optional onMouseMoveCapture#

        onMouseMoveCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1479

        +

        Defined in node_modules/@types/react/index.d.ts:1481


        Optional onMouseOut#

        onMouseOut? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOut

        -

        Defined in node_modules/@types/react/index.d.ts:1480

        +

        Defined in node_modules/@types/react/index.d.ts:1482


        Optional onMouseOutCapture#

        onMouseOutCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1481

        +

        Defined in node_modules/@types/react/index.d.ts:1483


        Optional onMouseOver#

        onMouseOver? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOver

        -

        Defined in node_modules/@types/react/index.d.ts:1482

        +

        Defined in node_modules/@types/react/index.d.ts:1484


        Optional onMouseOverCapture#

        onMouseOverCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1483

        +

        Defined in node_modules/@types/react/index.d.ts:1485


        Optional onMouseUp#

        onMouseUp? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseUp

        -

        Defined in node_modules/@types/react/index.d.ts:1484

        +

        Defined in node_modules/@types/react/index.d.ts:1486


        Optional onMouseUpCapture#

        onMouseUpCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1485

        +

        Defined in node_modules/@types/react/index.d.ts:1487


        Optional onPaste#

        onPaste? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onPaste

        -

        Defined in node_modules/@types/react/index.d.ts:1358

        +

        Defined in node_modules/@types/react/index.d.ts:1360


        Optional onPasteCapture#

        onPasteCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onPasteCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1359

        +

        Defined in node_modules/@types/react/index.d.ts:1361


        Optional onPause#

        onPause? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPause

        -

        Defined in node_modules/@types/react/index.d.ts:1424

        +

        Defined in node_modules/@types/react/index.d.ts:1426


        Optional onPauseCapture#

        onPauseCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPauseCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1425

        +

        Defined in node_modules/@types/react/index.d.ts:1427


        Optional onPlay#

        onPlay? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlay

        -

        Defined in node_modules/@types/react/index.d.ts:1426

        +

        Defined in node_modules/@types/react/index.d.ts:1428


        Optional onPlayCapture#

        onPlayCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlayCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1427

        +

        Defined in node_modules/@types/react/index.d.ts:1429


        Optional onPlaying#

        onPlaying? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlaying

        -

        Defined in node_modules/@types/react/index.d.ts:1428

        +

        Defined in node_modules/@types/react/index.d.ts:1430


        Optional onPlayingCapture#

        onPlayingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlayingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1429

        +

        Defined in node_modules/@types/react/index.d.ts:1431


        Optional onPointerCancel#

        onPointerCancel? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerCancel

        -

        Defined in node_modules/@types/react/index.d.ts:1508

        +

        Defined in node_modules/@types/react/index.d.ts:1510


        Optional onPointerCancelCapture#

        onPointerCancelCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerCancelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1509

        +

        Defined in node_modules/@types/react/index.d.ts:1511


        Optional onPointerDown#

        onPointerDown? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerDown

        -

        Defined in node_modules/@types/react/index.d.ts:1502

        +

        Defined in node_modules/@types/react/index.d.ts:1504


        Optional onPointerDownCapture#

        onPointerDownCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1503

        +

        Defined in node_modules/@types/react/index.d.ts:1505


        Optional onPointerEnter#

        onPointerEnter? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1510

        +

        Defined in node_modules/@types/react/index.d.ts:1512


        Optional onPointerEnterCapture#

        onPointerEnterCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerEnterCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1511

        +

        Defined in node_modules/@types/react/index.d.ts:1513


        Optional onPointerLeave#

        onPointerLeave? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1512

        +

        Defined in node_modules/@types/react/index.d.ts:1514


        Optional onPointerLeaveCapture#

        onPointerLeaveCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerLeaveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1513

        +

        Defined in node_modules/@types/react/index.d.ts:1515


        Optional onPointerMove#

        onPointerMove? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerMove

        -

        Defined in node_modules/@types/react/index.d.ts:1504

        +

        Defined in node_modules/@types/react/index.d.ts:1506


        Optional onPointerMoveCapture#

        onPointerMoveCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1505

        +

        Defined in node_modules/@types/react/index.d.ts:1507


        Optional onPointerOut#

        onPointerOut? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOut

        -

        Defined in node_modules/@types/react/index.d.ts:1516

        +

        Defined in node_modules/@types/react/index.d.ts:1518


        Optional onPointerOutCapture#

        onPointerOutCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1517

        +

        Defined in node_modules/@types/react/index.d.ts:1519


        Optional onPointerOver#

        onPointerOver? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOver

        -

        Defined in node_modules/@types/react/index.d.ts:1514

        +

        Defined in node_modules/@types/react/index.d.ts:1516


        Optional onPointerOverCapture#

        onPointerOverCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1515

        +

        Defined in node_modules/@types/react/index.d.ts:1517


        Optional onPointerUp#

        onPointerUp? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerUp

        -

        Defined in node_modules/@types/react/index.d.ts:1506

        +

        Defined in node_modules/@types/react/index.d.ts:1508


        Optional onPointerUpCapture#

        onPointerUpCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1507

        +

        Defined in node_modules/@types/react/index.d.ts:1509


        Optional onProgress#

        onProgress? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onProgress

        -

        Defined in node_modules/@types/react/index.d.ts:1430

        +

        Defined in node_modules/@types/react/index.d.ts:1432


        Optional onProgressCapture#

        onProgressCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onProgressCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1431

        +

        Defined in node_modules/@types/react/index.d.ts:1433


        Optional onRateChange#

        onRateChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onRateChange

        -

        Defined in node_modules/@types/react/index.d.ts:1432

        +

        Defined in node_modules/@types/react/index.d.ts:1434


        Optional onRateChangeCapture#

        onRateChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onRateChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1433

        +

        Defined in node_modules/@types/react/index.d.ts:1435


        Optional onReset#

        onReset? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onReset

        -

        Defined in node_modules/@types/react/index.d.ts:1382

        +

        Defined in node_modules/@types/react/index.d.ts:1384


        Optional onResetCapture#

        onResetCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onResetCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1383

        +

        Defined in node_modules/@types/react/index.d.ts:1385


        Optional onScroll#

        onScroll? : UIEventHandler‹any›

        Inherited from PageLayoutProps.onScroll

        -

        Defined in node_modules/@types/react/index.d.ts:1524

        +

        Defined in node_modules/@types/react/index.d.ts:1526


        Optional onScrollCapture#

        onScrollCapture? : UIEventHandler‹any›

        Inherited from PageLayoutProps.onScrollCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1525

        +

        Defined in node_modules/@types/react/index.d.ts:1527


        Optional onSeeked#

        onSeeked? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeeked

        -

        Defined in node_modules/@types/react/index.d.ts:1434

        +

        Defined in node_modules/@types/react/index.d.ts:1436


        Optional onSeekedCapture#

        onSeekedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeekedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1435

        +

        Defined in node_modules/@types/react/index.d.ts:1437


        Optional onSeeking#

        onSeeking? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeeking

        -

        Defined in node_modules/@types/react/index.d.ts:1436

        +

        Defined in node_modules/@types/react/index.d.ts:1438


        Optional onSeekingCapture#

        onSeekingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeekingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1437

        +

        Defined in node_modules/@types/react/index.d.ts:1439


        Optional onSelect#

        onSelect? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSelect

        -

        Defined in node_modules/@types/react/index.d.ts:1488

        +

        Defined in node_modules/@types/react/index.d.ts:1490


        Optional onSelectCapture#

        onSelectCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSelectCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1489

        +

        Defined in node_modules/@types/react/index.d.ts:1491


        Optional onStalled#

        onStalled? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onStalled

        -

        Defined in node_modules/@types/react/index.d.ts:1438

        +

        Defined in node_modules/@types/react/index.d.ts:1440


        Optional onStalledCapture#

        onStalledCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onStalledCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1439

        +

        Defined in node_modules/@types/react/index.d.ts:1441


        Optional onSubmit#

        onSubmit? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onSubmit

        -

        Defined in node_modules/@types/react/index.d.ts:1384

        +

        Defined in node_modules/@types/react/index.d.ts:1386


        Optional onSubmitCapture#

        onSubmitCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onSubmitCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1385

        +

        Defined in node_modules/@types/react/index.d.ts:1387


        Optional onSuspend#

        onSuspend? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSuspend

        -

        Defined in node_modules/@types/react/index.d.ts:1440

        +

        Defined in node_modules/@types/react/index.d.ts:1442


        Optional onSuspendCapture#

        onSuspendCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSuspendCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1441

        +

        Defined in node_modules/@types/react/index.d.ts:1443


        Optional onTimeUpdate#

        onTimeUpdate? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onTimeUpdate

        -

        Defined in node_modules/@types/react/index.d.ts:1442

        +

        Defined in node_modules/@types/react/index.d.ts:1444


        Optional onTimeUpdateCapture#

        onTimeUpdateCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onTimeUpdateCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1443

        +

        Defined in node_modules/@types/react/index.d.ts:1445


        Optional onTouchCancel#

        onTouchCancel? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchCancel

        -

        Defined in node_modules/@types/react/index.d.ts:1492

        +

        Defined in node_modules/@types/react/index.d.ts:1494


        Optional onTouchCancelCapture#

        onTouchCancelCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchCancelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1493

        +

        Defined in node_modules/@types/react/index.d.ts:1495


        Optional onTouchEnd#

        onTouchEnd? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1494

        +

        Defined in node_modules/@types/react/index.d.ts:1496


        Optional onTouchEndCapture#

        onTouchEndCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1495

        +

        Defined in node_modules/@types/react/index.d.ts:1497


        Optional onTouchMove#

        onTouchMove? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchMove

        -

        Defined in node_modules/@types/react/index.d.ts:1496

        +

        Defined in node_modules/@types/react/index.d.ts:1498


        Optional onTouchMoveCapture#

        onTouchMoveCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1497

        +

        Defined in node_modules/@types/react/index.d.ts:1499


        Optional onTouchStart#

        onTouchStart? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchStart

        -

        Defined in node_modules/@types/react/index.d.ts:1498

        +

        Defined in node_modules/@types/react/index.d.ts:1500


        Optional onTouchStartCapture#

        onTouchStartCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1499

        +

        Defined in node_modules/@types/react/index.d.ts:1501


        Optional onTransitionEnd#

        onTransitionEnd? : TransitionEventHandler‹any›

        Inherited from PageLayoutProps.onTransitionEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1540

        +

        Defined in node_modules/@types/react/index.d.ts:1542


        Optional onTransitionEndCapture#

        onTransitionEndCapture? : TransitionEventHandler‹any›

        Inherited from PageLayoutProps.onTransitionEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1541

        +

        Defined in node_modules/@types/react/index.d.ts:1543


        Optional onVolumeChange#

        onVolumeChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onVolumeChange

        -

        Defined in node_modules/@types/react/index.d.ts:1444

        +

        Defined in node_modules/@types/react/index.d.ts:1446


        Optional onVolumeChangeCapture#

        onVolumeChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onVolumeChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1445

        +

        Defined in node_modules/@types/react/index.d.ts:1447


        Optional onWaiting#

        onWaiting? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onWaiting

        -

        Defined in node_modules/@types/react/index.d.ts:1446

        +

        Defined in node_modules/@types/react/index.d.ts:1448


        Optional onWaitingCapture#

        onWaitingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onWaitingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1447

        +

        Defined in node_modules/@types/react/index.d.ts:1449


        Optional onWheel#

        onWheel? : WheelEventHandler‹any›

        Inherited from PageLayoutProps.onWheel

        -

        Defined in node_modules/@types/react/index.d.ts:1528

        +

        Defined in node_modules/@types/react/index.d.ts:1530


        Optional onWheelCapture#

        onWheelCapture? : WheelEventHandler‹any›

        Inherited from PageLayoutProps.onWheelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1529

        +

        Defined in node_modules/@types/react/index.d.ts:1531


        Optional open#

        open? : boolean

        Inherited from LineProgressProps.open

        -

        Defined in node_modules/@types/react/index.d.ts:1882

        +

        Defined in node_modules/@types/react/index.d.ts:1884


        Optional optimum#

        optimum? : number

        Inherited from LineProgressProps.optimum

        -

        Defined in node_modules/@types/react/index.d.ts:1883

        +

        Defined in node_modules/@types/react/index.d.ts:1885


        Optional pattern#

        pattern? : string

        Inherited from LineProgressProps.pattern

        -

        Defined in node_modules/@types/react/index.d.ts:1884

        +

        Defined in node_modules/@types/react/index.d.ts:1886


        Optional placeholder#

        placeholder? : string

        Inherited from LineProgressProps.placeholder

        Overrides ButtonProps.placeholder

        -

        Defined in node_modules/@types/react/index.d.ts:1885

        +

        Defined in node_modules/@types/react/index.d.ts:1887


        Optional playsInline#

        playsInline? : boolean

        Inherited from LineProgressProps.playsInline

        -

        Defined in node_modules/@types/react/index.d.ts:1886

        +

        Defined in node_modules/@types/react/index.d.ts:1888


        Optional poster#

        poster? : string

        Inherited from LineProgressProps.poster

        -

        Defined in node_modules/@types/react/index.d.ts:1887

        +

        Defined in node_modules/@types/react/index.d.ts:1889


        Optional prefix#

        prefix? : string

        Inherited from ButtonProps.prefix

        -

        Defined in node_modules/@types/react/index.d.ts:1778

        +

        Defined in node_modules/@types/react/index.d.ts:1780


        Optional preload#

        preload? : string

        Inherited from LineProgressProps.preload

        -

        Defined in node_modules/@types/react/index.d.ts:1888

        +

        Defined in node_modules/@types/react/index.d.ts:1890


        Optional property#

        property? : string

        Inherited from ButtonProps.property

        -

        Defined in node_modules/@types/react/index.d.ts:1779

        +

        Defined in node_modules/@types/react/index.d.ts:1781


        Optional radioGroup#

        radioGroup? : string

        Inherited from ButtonProps.radioGroup

        -

        Defined in node_modules/@types/react/index.d.ts:1769

        +

        Defined in node_modules/@types/react/index.d.ts:1771


        Optional readOnly#

        readOnly? : boolean

        Inherited from LineProgressProps.readOnly

        -

        Defined in node_modules/@types/react/index.d.ts:1889

        +

        Defined in node_modules/@types/react/index.d.ts:1891


        Optional ref#

        ref? : LegacyRef‹any›

        Inherited from LineProgressProps.ref

        -

        Defined in node_modules/@types/react/index.d.ts:145

        +

        Defined in node_modules/@types/react/index.d.ts:143


        Optional rel#

        rel? : string

        Inherited from LineProgressProps.rel

        -

        Defined in node_modules/@types/react/index.d.ts:1890

        +

        Defined in node_modules/@types/react/index.d.ts:1892


        Optional required#

        required? : boolean

        Inherited from LineProgressProps.required

        -

        Defined in node_modules/@types/react/index.d.ts:1891

        +

        Defined in node_modules/@types/react/index.d.ts:1893


        Optional resource#

        resource? : string

        Inherited from ButtonProps.resource

        -

        Defined in node_modules/@types/react/index.d.ts:1780

        +

        Defined in node_modules/@types/react/index.d.ts:1782


        Optional results#

        results? : number

        Inherited from ButtonProps.results

        -

        Defined in node_modules/@types/react/index.d.ts:1794

        +

        Defined in node_modules/@types/react/index.d.ts:1796


        Optional reversed#

        reversed? : boolean

        Inherited from LineProgressProps.reversed

        -

        Defined in node_modules/@types/react/index.d.ts:1892

        +

        Defined in node_modules/@types/react/index.d.ts:1894


        Optional role#

        role? : string

        Inherited from ButtonProps.role

        -

        Defined in node_modules/@types/react/index.d.ts:1772

        +

        Defined in node_modules/@types/react/index.d.ts:1774


        Optional rowSpan#

        rowSpan? : number

        Inherited from LineProgressProps.rowSpan

        -

        Defined in node_modules/@types/react/index.d.ts:1894

        +

        Defined in node_modules/@types/react/index.d.ts:1896


        Optional rows#

        rows? : number

        Inherited from LineProgressProps.rows

        -

        Defined in node_modules/@types/react/index.d.ts:1893

        +

        Defined in node_modules/@types/react/index.d.ts:1895


        Optional sandbox#

        sandbox? : string

        Inherited from LineProgressProps.sandbox

        -

        Defined in node_modules/@types/react/index.d.ts:1895

        +

        Defined in node_modules/@types/react/index.d.ts:1897


        Optional scope#

        scope? : string

        Inherited from LineProgressProps.scope

        -

        Defined in node_modules/@types/react/index.d.ts:1896

        +

        Defined in node_modules/@types/react/index.d.ts:1898


        Optional scoped#

        scoped? : boolean

        Inherited from LineProgressProps.scoped

        -

        Defined in node_modules/@types/react/index.d.ts:1897

        +

        Defined in node_modules/@types/react/index.d.ts:1899


        Optional scrolling#

        scrolling? : string

        Inherited from LineProgressProps.scrolling

        -

        Defined in node_modules/@types/react/index.d.ts:1898

        +

        Defined in node_modules/@types/react/index.d.ts:1900


        Optional seamless#

        seamless? : boolean

        Inherited from LineProgressProps.seamless

        -

        Defined in node_modules/@types/react/index.d.ts:1899

        +

        Defined in node_modules/@types/react/index.d.ts:1901


        Optional security#

        security? : string

        Inherited from ButtonProps.security

        -

        Defined in node_modules/@types/react/index.d.ts:1795

        +

        Defined in node_modules/@types/react/index.d.ts:1797


        Optional selected#

        selected? : boolean

        Inherited from LineProgressProps.selected

        -

        Defined in node_modules/@types/react/index.d.ts:1900

        +

        Defined in node_modules/@types/react/index.d.ts:1902


        Optional shape#

        shape? : string

        Inherited from LineProgressProps.shape

        -

        Defined in node_modules/@types/react/index.d.ts:1901

        +

        Defined in node_modules/@types/react/index.d.ts:1903


        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

        Inherited from LineProgressProps.size

        -

        Defined in node_modules/@types/react/index.d.ts:1902

        +

        Defined in node_modules/@types/react/index.d.ts:1904


        Optional sizes#

        sizes? : string

        Inherited from LineProgressProps.sizes

        -

        Defined in node_modules/@types/react/index.d.ts:1903

        +

        Defined in node_modules/@types/react/index.d.ts:1905


        Optional slot#

        slot? : string

        Inherited from ButtonProps.slot

        -

        Defined in node_modules/@types/react/index.d.ts:1761

        +

        Defined in node_modules/@types/react/index.d.ts:1763


        Optional span#

        span? : number

        Inherited from LineProgressProps.span

        -

        Defined in node_modules/@types/react/index.d.ts:1904

        +

        Defined in node_modules/@types/react/index.d.ts:1906


        Optional spellCheck#

        spellCheck? : Booleanish

        Inherited from ButtonProps.spellCheck

        -

        Defined in node_modules/@types/react/index.d.ts:1762

        +

        Defined in node_modules/@types/react/index.d.ts:1764


        Optional src#

        src? : string

        Inherited from LineProgressProps.src

        -

        Defined in node_modules/@types/react/index.d.ts:1905

        +

        Defined in node_modules/@types/react/index.d.ts:1907


        Optional srcDoc#

        srcDoc? : string

        Inherited from LineProgressProps.srcDoc

        -

        Defined in node_modules/@types/react/index.d.ts:1906

        +

        Defined in node_modules/@types/react/index.d.ts:1908


        Optional srcLang#

        srcLang? : string

        Inherited from LineProgressProps.srcLang

        -

        Defined in node_modules/@types/react/index.d.ts:1907

        +

        Defined in node_modules/@types/react/index.d.ts:1909


        Optional srcSet#

        srcSet? : string

        Inherited from LineProgressProps.srcSet

        -

        Defined in node_modules/@types/react/index.d.ts:1908

        +

        Defined in node_modules/@types/react/index.d.ts:1910


        Optional start#

        start? : number

        Inherited from LineProgressProps.start

        -

        Defined in node_modules/@types/react/index.d.ts:1909

        +

        Defined in node_modules/@types/react/index.d.ts:1911


        Optional step#

        step? : number | string

        Inherited from LineProgressProps.step

        -

        Defined in node_modules/@types/react/index.d.ts:1910

        +

        Defined in node_modules/@types/react/index.d.ts:1912


        Optional style#

        style? : CSSProperties

        Inherited from ButtonProps.style

        -

        Defined in node_modules/@types/react/index.d.ts:1763

        +

        Defined in node_modules/@types/react/index.d.ts:1765


        Optional summary#

        summary? : string

        Inherited from LineProgressProps.summary

        -

        Defined in node_modules/@types/react/index.d.ts:1911

        +

        Defined in node_modules/@types/react/index.d.ts:1913


        Optional suppressContentEditableWarning#

        suppressContentEditableWarning? : boolean

        Inherited from ButtonProps.suppressContentEditableWarning

        -

        Defined in node_modules/@types/react/index.d.ts:1747

        +

        Defined in node_modules/@types/react/index.d.ts:1749


        Optional suppressHydrationWarning#

        suppressHydrationWarning? : boolean

        Inherited from ButtonProps.suppressHydrationWarning

        -

        Defined in node_modules/@types/react/index.d.ts:1748

        +

        Defined in node_modules/@types/react/index.d.ts:1750


        Optional tabIndex#

        tabIndex? : number

        Inherited from ButtonProps.tabIndex

        -

        Defined in node_modules/@types/react/index.d.ts:1764

        +

        Defined in node_modules/@types/react/index.d.ts:1766


        Optional target#

        target? : string

        Inherited from LineProgressProps.target

        -

        Defined in node_modules/@types/react/index.d.ts:1912

        +

        Defined in node_modules/@types/react/index.d.ts:1914


        Optional title#

        title? : string

        Inherited from ButtonProps.title

        -

        Defined in node_modules/@types/react/index.d.ts:1765

        +

        Defined in node_modules/@types/react/index.d.ts:1767


        Optional translate#

        translate? : "yes" | "no"

        Inherited from ButtonProps.translate

        -

        Defined in node_modules/@types/react/index.d.ts:1766

        +

        Defined in node_modules/@types/react/index.d.ts:1768


        Optional type#

        type? : string

        Inherited from LineProgressProps.type

        -

        Defined in node_modules/@types/react/index.d.ts:1913

        +

        Defined in node_modules/@types/react/index.d.ts:1915


        Optional typeof#

        typeof? : string

        Inherited from ButtonProps.typeof

        -

        Defined in node_modules/@types/react/index.d.ts:1781

        +

        Defined in node_modules/@types/react/index.d.ts:1783


        Optional unselectable#

        unselectable? : "on" | "off"

        Inherited from ButtonProps.unselectable

        -

        Defined in node_modules/@types/react/index.d.ts:1796

        +

        Defined in node_modules/@types/react/index.d.ts:1798


        Optional useMap#

        useMap? : string

        Inherited from LineProgressProps.useMap

        -

        Defined in node_modules/@types/react/index.d.ts:1914

        +

        Defined in node_modules/@types/react/index.d.ts:1916


        Optional value#

        -

        value? : string | string[] | number

        +

        value? : string | ReadonlyArray‹string› | number

        Inherited from MenuItemProps.value

        -

        Defined in node_modules/@types/react/index.d.ts:1915

        +

        Defined in node_modules/@types/react/index.d.ts:1917


        Optional vocab#

        vocab? : string

        Inherited from ButtonProps.vocab

        -

        Defined in node_modules/@types/react/index.d.ts:1782

        +

        Defined in node_modules/@types/react/index.d.ts:1784


        Optional width#

        width? : number | string

        Inherited from LineProgressProps.width

        -

        Defined in node_modules/@types/react/index.d.ts:1916

        +

        Defined in node_modules/@types/react/index.d.ts:1918


        Optional wmode#

        wmode? : string

        Inherited from LineProgressProps.wmode

        -

        Defined in node_modules/@types/react/index.d.ts:1917

        +

        Defined in node_modules/@types/react/index.d.ts:1919


        Optional wrap#

        wrap? : string

        Inherited from LineProgressProps.wrap

        -

        Defined in node_modules/@types/react/index.d.ts:1918

        +

        Defined in node_modules/@types/react/index.d.ts:1920

        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 50149054bf..7a7600f7fb 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -2934,214 +2934,214 @@

        Optional about#

        about? : string

        Inherited from ButtonProps.about

        -

        Defined in node_modules/@types/react/index.d.ts:1775

        +

        Defined in node_modules/@types/react/index.d.ts:1777


        Optional accessKey#

        accessKey? : string

        Inherited from ButtonProps.accessKey

        -

        Defined in node_modules/@types/react/index.d.ts:1751

        +

        Defined in node_modules/@types/react/index.d.ts:1753


        Optional aria-activedescendant#

        aria-activedescendant? : string

        Inherited from ButtonProps.aria-activedescendant

        -

        Defined in node_modules/@types/react/index.d.ts:1558

        +

        Defined in node_modules/@types/react/index.d.ts:1560

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1562

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1567

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1569

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1574

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1579

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1584

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1589

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1594

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1596

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1601

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1606

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1611

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1616

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1621

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1623

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1628

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1633

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1635

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1640

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1645

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1647

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1652

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1657

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1659

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1661

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1663

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1665

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1667

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1669

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1675

        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.

        @@ -3149,160 +3149,160 @@ between DOM elements where the DOM hierarchy cannot be used to represent the rel

        Optional aria-placeholder#

        aria-placeholder? : string

        Inherited from ButtonProps.aria-placeholder

        -

        Defined in node_modules/@types/react/index.d.ts:1678

        +

        Defined in node_modules/@types/react/index.d.ts:1680

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1685

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1690

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1695

        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"

        +

        aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

        Inherited from ButtonProps.aria-relevant

        -

        Defined in node_modules/@types/react/index.d.ts:1698

        +

        Defined in node_modules/@types/react/index.d.ts:1700

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1702

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1704

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1709

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1714

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1719

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1724

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1729

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1731

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1733

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1735

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1740

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1742

        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

        +

        Defined in node_modules/@types/react/index.d.ts:1787


        Optional autoCorrect#

        autoCorrect? : string

        Inherited from ButtonProps.autoCorrect

        -

        Defined in node_modules/@types/react/index.d.ts:1786

        +

        Defined in node_modules/@types/react/index.d.ts:1788


        Optional autoSave#

        autoSave? : string

        Inherited from ButtonProps.autoSave

        -

        Defined in node_modules/@types/react/index.d.ts:1787

        +

        Defined in node_modules/@types/react/index.d.ts:1789


        Optional children#

        children? : ReactNode

        Inherited from PageLayoutProps.children

        -

        Defined in node_modules/@types/react/index.d.ts:1348

        +

        Defined in node_modules/@types/react/index.d.ts:1350


        Optional className#

        className? : string

        Inherited from ButtonProps.className

        -

        Defined in node_modules/@types/react/index.d.ts:1752

        +

        Defined in node_modules/@types/react/index.d.ts:1754


        Optional color#

        color? : string

        Inherited from ButtonProps.color

        -

        Defined in node_modules/@types/react/index.d.ts:1788

        +

        Defined in node_modules/@types/react/index.d.ts:1790


        Optional contentEditable#

        contentEditable? : Booleanish | "inherit"

        Inherited from ButtonProps.contentEditable

        -

        Defined in node_modules/@types/react/index.d.ts:1753

        +

        Defined in node_modules/@types/react/index.d.ts:1755


        Optional contextMenu#

        contextMenu? : string

        Inherited from ButtonProps.contextMenu

        -

        Defined in node_modules/@types/react/index.d.ts:1754

        +

        Defined in node_modules/@types/react/index.d.ts:1756


        Optional dangerouslySetInnerHTML#

        dangerouslySetInnerHTML? : object

        Inherited from PageLayoutProps.dangerouslySetInnerHTML

        -

        Defined in node_modules/@types/react/index.d.ts:1349

        +

        Defined in node_modules/@types/react/index.d.ts:1351

        Type declaration:

        • __html: string
        • @@ -3311,993 +3311,993 @@ A hint could be a sample value or a brief description of the expected format.

          Optional datatype#

          datatype? : string

          Inherited from ButtonProps.datatype

          -

          Defined in node_modules/@types/react/index.d.ts:1776

          +

          Defined in node_modules/@types/react/index.d.ts:1778


          Optional defaultChecked#

          defaultChecked? : boolean

          Inherited from ButtonProps.defaultChecked

          -

          Defined in node_modules/@types/react/index.d.ts:1745

          +

          Defined in node_modules/@types/react/index.d.ts:1747


          Optional defaultValue#

          -

          defaultValue? : string | number | string[]

          +

          defaultValue? : string | number | ReadonlyArray‹string›

          Inherited from ButtonProps.defaultValue

          -

          Defined in node_modules/@types/react/index.d.ts:1746

          +

          Defined in node_modules/@types/react/index.d.ts:1748


          Optional dir#

          dir? : string

          Inherited from ButtonProps.dir

          -

          Defined in node_modules/@types/react/index.d.ts:1755

          +

          Defined in node_modules/@types/react/index.d.ts:1757


          Optional draggable#

          draggable? : Booleanish

          Inherited from ButtonProps.draggable

          -

          Defined in node_modules/@types/react/index.d.ts:1756

          +

          Defined in node_modules/@types/react/index.d.ts:1758


          Optional hidden#

          hidden? : boolean

          Inherited from IconProps.hidden

          -

          Defined in node_modules/@types/react/index.d.ts:1757

          +

          Defined in node_modules/@types/react/index.d.ts:1759


          Optional id#

          id? : string

          Inherited from ButtonProps.id

          -

          Defined in node_modules/@types/react/index.d.ts:1758

          +

          Defined in node_modules/@types/react/index.d.ts:1760


          Optional inlist#

          inlist? : any

          Inherited from ButtonProps.inlist

          -

          Defined in node_modules/@types/react/index.d.ts:1777

          +

          Defined in node_modules/@types/react/index.d.ts:1779


          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

          +

          Defined in node_modules/@types/react/index.d.ts:1805

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1810

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1794


          Optional itemProp#

          itemProp? : string

          Inherited from ButtonProps.itemProp

          -

          Defined in node_modules/@types/react/index.d.ts:1789

          +

          Defined in node_modules/@types/react/index.d.ts:1791


          Optional itemRef#

          itemRef? : string

          Inherited from ButtonProps.itemRef

          -

          Defined in node_modules/@types/react/index.d.ts:1793

          +

          Defined in node_modules/@types/react/index.d.ts:1795


          Optional itemScope#

          itemScope? : boolean

          Inherited from ButtonProps.itemScope

          -

          Defined in node_modules/@types/react/index.d.ts:1790

          +

          Defined in node_modules/@types/react/index.d.ts:1792


          Optional itemType#

          itemType? : string

          Inherited from ButtonProps.itemType

          -

          Defined in node_modules/@types/react/index.d.ts:1791

          +

          Defined in node_modules/@types/react/index.d.ts:1793


          Optional lang#

          lang? : string

          Inherited from ButtonProps.lang

          -

          Defined in node_modules/@types/react/index.d.ts:1759

          +

          Defined in node_modules/@types/react/index.d.ts:1761


          Optional onAbort#

          onAbort? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onAbort

          -

          Defined in node_modules/@types/react/index.d.ts:1404

          +

          Defined in node_modules/@types/react/index.d.ts:1406


          Optional onAbortCapture#

          onAbortCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onAbortCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1405

          +

          Defined in node_modules/@types/react/index.d.ts:1407


          Optional onAnimationEnd#

          onAnimationEnd? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1534

          +

          Defined in node_modules/@types/react/index.d.ts:1536


          Optional onAnimationEndCapture#

          onAnimationEndCapture? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1535

          +

          Defined in node_modules/@types/react/index.d.ts:1537


          Optional onAnimationIteration#

          onAnimationIteration? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationIteration

          -

          Defined in node_modules/@types/react/index.d.ts:1536

          +

          Defined in node_modules/@types/react/index.d.ts:1538


          Optional onAnimationIterationCapture#

          onAnimationIterationCapture? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationIterationCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1537

          +

          Defined in node_modules/@types/react/index.d.ts:1539


          Optional onAnimationStart#

          onAnimationStart? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationStart

          -

          Defined in node_modules/@types/react/index.d.ts:1532

          +

          Defined in node_modules/@types/react/index.d.ts:1534


          Optional onAnimationStartCapture#

          onAnimationStartCapture? : AnimationEventHandler‹any›

          Inherited from PageLayoutProps.onAnimationStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1533

          +

          Defined in node_modules/@types/react/index.d.ts:1535


          Optional onAuxClick#

          onAuxClick? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onAuxClick

          -

          Defined in node_modules/@types/react/index.d.ts:1450

          +

          Defined in node_modules/@types/react/index.d.ts:1452


          Optional onAuxClickCapture#

          onAuxClickCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onAuxClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1451

          +

          Defined in node_modules/@types/react/index.d.ts:1453


          Optional onBeforeInput#

          onBeforeInput? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onBeforeInput

          -

          Defined in node_modules/@types/react/index.d.ts:1378

          +

          Defined in node_modules/@types/react/index.d.ts:1380


          Optional onBeforeInputCapture#

          onBeforeInputCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onBeforeInputCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1379

          +

          Defined in node_modules/@types/react/index.d.ts:1381


          Optional onBlur#

          onBlur? : FocusEventHandler‹any›

          Inherited from PageLayoutProps.onBlur

          -

          Defined in node_modules/@types/react/index.d.ts:1372

          +

          Defined in node_modules/@types/react/index.d.ts:1374


          Optional onBlurCapture#

          onBlurCapture? : FocusEventHandler‹any›

          Inherited from PageLayoutProps.onBlurCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1373

          +

          Defined in node_modules/@types/react/index.d.ts:1375


          Optional onCanPlay#

          onCanPlay? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onCanPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1406

          +

          Defined in node_modules/@types/react/index.d.ts:1408


          Optional onCanPlayCapture#

          onCanPlayCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onCanPlayCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1407

          +

          Defined in node_modules/@types/react/index.d.ts:1409


          Optional onCanPlayThrough#

          onCanPlayThrough? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onCanPlayThrough

          -

          Defined in node_modules/@types/react/index.d.ts:1408

          +

          Defined in node_modules/@types/react/index.d.ts:1410


          Optional onCanPlayThroughCapture#

          onCanPlayThroughCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onCanPlayThroughCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1409

          +

          Defined in node_modules/@types/react/index.d.ts:1411


          Optional onChange#

          onChange? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onChange

          -

          Defined in node_modules/@types/react/index.d.ts:1376

          +

          Defined in node_modules/@types/react/index.d.ts:1378


          Optional onChangeCapture#

          onChangeCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1377

          +

          Defined in node_modules/@types/react/index.d.ts:1379


          Optional onClick#

          onClick? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onClick

          -

          Defined in node_modules/@types/react/index.d.ts:1452

          +

          Defined in node_modules/@types/react/index.d.ts:1454


          Optional onClickCapture#

          onClickCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1453

          +

          Defined in node_modules/@types/react/index.d.ts:1455


          Optional onCompositionEnd#

          onCompositionEnd? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1362

          +

          Defined in node_modules/@types/react/index.d.ts:1364


          Optional onCompositionEndCapture#

          onCompositionEndCapture? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1363

          +

          Defined in node_modules/@types/react/index.d.ts:1365


          Optional onCompositionStart#

          onCompositionStart? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionStart

          -

          Defined in node_modules/@types/react/index.d.ts:1364

          +

          Defined in node_modules/@types/react/index.d.ts:1366


          Optional onCompositionStartCapture#

          onCompositionStartCapture? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1365

          +

          Defined in node_modules/@types/react/index.d.ts:1367


          Optional onCompositionUpdate#

          onCompositionUpdate? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionUpdate

          -

          Defined in node_modules/@types/react/index.d.ts:1366

          +

          Defined in node_modules/@types/react/index.d.ts:1368


          Optional onCompositionUpdateCapture#

          onCompositionUpdateCapture? : CompositionEventHandler‹any›

          Inherited from PageLayoutProps.onCompositionUpdateCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1367

          +

          Defined in node_modules/@types/react/index.d.ts:1369


          Optional onContextMenu#

          onContextMenu? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onContextMenu

          -

          Defined in node_modules/@types/react/index.d.ts:1454

          +

          Defined in node_modules/@types/react/index.d.ts:1456


          Optional onContextMenuCapture#

          onContextMenuCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onContextMenuCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1455

          +

          Defined in node_modules/@types/react/index.d.ts:1457


          Optional onCopy#

          onCopy? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onCopy

          -

          Defined in node_modules/@types/react/index.d.ts:1354

          +

          Defined in node_modules/@types/react/index.d.ts:1356


          Optional onCopyCapture#

          onCopyCapture? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onCopyCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1355

          +

          Defined in node_modules/@types/react/index.d.ts:1357


          Optional onCut#

          onCut? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onCut

          -

          Defined in node_modules/@types/react/index.d.ts:1356

          +

          Defined in node_modules/@types/react/index.d.ts:1358


          Optional onCutCapture#

          onCutCapture? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onCutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1357

          +

          Defined in node_modules/@types/react/index.d.ts:1359


          Optional onDoubleClick#

          onDoubleClick? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onDoubleClick

          -

          Defined in node_modules/@types/react/index.d.ts:1456

          +

          Defined in node_modules/@types/react/index.d.ts:1458


          Optional onDoubleClickCapture#

          onDoubleClickCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onDoubleClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1457

          +

          Defined in node_modules/@types/react/index.d.ts:1459


          Optional onDrag#

          onDrag? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDrag

          -

          Defined in node_modules/@types/react/index.d.ts:1458

          +

          Defined in node_modules/@types/react/index.d.ts:1460


          Optional onDragCapture#

          onDragCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1459

          +

          Defined in node_modules/@types/react/index.d.ts:1461


          Optional onDragEnd#

          onDragEnd? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1460

          +

          Defined in node_modules/@types/react/index.d.ts:1462


          Optional onDragEndCapture#

          onDragEndCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1461

          +

          Defined in node_modules/@types/react/index.d.ts:1463


          Optional onDragEnter#

          onDragEnter? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1462

          +

          Defined in node_modules/@types/react/index.d.ts:1464


          Optional onDragEnterCapture#

          onDragEnterCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragEnterCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1463

          +

          Defined in node_modules/@types/react/index.d.ts:1465


          Optional onDragExit#

          onDragExit? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragExit

          -

          Defined in node_modules/@types/react/index.d.ts:1464

          +

          Defined in node_modules/@types/react/index.d.ts:1466


          Optional onDragExitCapture#

          onDragExitCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragExitCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1465

          +

          Defined in node_modules/@types/react/index.d.ts:1467


          Optional onDragLeave#

          onDragLeave? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1466

          +

          Defined in node_modules/@types/react/index.d.ts:1468


          Optional onDragLeaveCapture#

          onDragLeaveCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragLeaveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1467

          +

          Defined in node_modules/@types/react/index.d.ts:1469


          Optional onDragOver#

          onDragOver? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragOver

          -

          Defined in node_modules/@types/react/index.d.ts:1468

          +

          Defined in node_modules/@types/react/index.d.ts:1470


          Optional onDragOverCapture#

          onDragOverCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1469

          +

          Defined in node_modules/@types/react/index.d.ts:1471


          Optional onDragStart#

          onDragStart? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragStart

          -

          Defined in node_modules/@types/react/index.d.ts:1470

          +

          Defined in node_modules/@types/react/index.d.ts:1472


          Optional onDragStartCapture#

          onDragStartCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDragStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1471

          +

          Defined in node_modules/@types/react/index.d.ts:1473


          Optional onDrop#

          onDrop? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDrop

          -

          Defined in node_modules/@types/react/index.d.ts:1472

          +

          Defined in node_modules/@types/react/index.d.ts:1474


          Optional onDropCapture#

          onDropCapture? : DragEventHandler‹any›

          Inherited from PageLayoutProps.onDropCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1473

          +

          Defined in node_modules/@types/react/index.d.ts:1475


          Optional onDurationChange#

          onDurationChange? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onDurationChange

          -

          Defined in node_modules/@types/react/index.d.ts:1410

          +

          Defined in node_modules/@types/react/index.d.ts:1412


          Optional onDurationChangeCapture#

          onDurationChangeCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onDurationChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1411

          +

          Defined in node_modules/@types/react/index.d.ts:1413


          Optional onEmptied#

          onEmptied? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEmptied

          -

          Defined in node_modules/@types/react/index.d.ts:1412

          +

          Defined in node_modules/@types/react/index.d.ts:1414


          Optional onEmptiedCapture#

          onEmptiedCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEmptiedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1413

          +

          Defined in node_modules/@types/react/index.d.ts:1415


          Optional onEncrypted#

          onEncrypted? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEncrypted

          -

          Defined in node_modules/@types/react/index.d.ts:1414

          +

          Defined in node_modules/@types/react/index.d.ts:1416


          Optional onEncryptedCapture#

          onEncryptedCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEncryptedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1415

          +

          Defined in node_modules/@types/react/index.d.ts:1417


          Optional onEnded#

          onEnded? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEnded

          -

          Defined in node_modules/@types/react/index.d.ts:1416

          +

          Defined in node_modules/@types/react/index.d.ts:1418


          Optional onEndedCapture#

          onEndedCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onEndedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1417

          +

          Defined in node_modules/@types/react/index.d.ts:1419


          Optional onError#

          onError? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onError

          -

          Defined in node_modules/@types/react/index.d.ts:1392

          +

          Defined in node_modules/@types/react/index.d.ts:1394


          Optional onErrorCapture#

          onErrorCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onErrorCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1393

          +

          Defined in node_modules/@types/react/index.d.ts:1395


          Optional onFocus#

          onFocus? : FocusEventHandler‹any›

          Inherited from PageLayoutProps.onFocus

          -

          Defined in node_modules/@types/react/index.d.ts:1370

          +

          Defined in node_modules/@types/react/index.d.ts:1372


          Optional onFocusCapture#

          onFocusCapture? : FocusEventHandler‹any›

          Inherited from PageLayoutProps.onFocusCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1371

          +

          Defined in node_modules/@types/react/index.d.ts:1373


          Optional onGotPointerCapture#

          onGotPointerCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onGotPointerCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1518

          +

          Defined in node_modules/@types/react/index.d.ts:1520


          Optional onGotPointerCaptureCapture#

          onGotPointerCaptureCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onGotPointerCaptureCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1519

          +

          Defined in node_modules/@types/react/index.d.ts:1521


          Optional onInput#

          onInput? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onInput

          -

          Defined in node_modules/@types/react/index.d.ts:1380

          +

          Defined in node_modules/@types/react/index.d.ts:1382


          Optional onInputCapture#

          onInputCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onInputCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1381

          +

          Defined in node_modules/@types/react/index.d.ts:1383


          Optional onInvalid#

          onInvalid? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onInvalid

          -

          Defined in node_modules/@types/react/index.d.ts:1386

          +

          Defined in node_modules/@types/react/index.d.ts:1388


          Optional onInvalidCapture#

          onInvalidCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onInvalidCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1387

          +

          Defined in node_modules/@types/react/index.d.ts:1389


          Optional onKeyDown#

          onKeyDown? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyDown

          -

          Defined in node_modules/@types/react/index.d.ts:1396

          +

          Defined in node_modules/@types/react/index.d.ts:1398


          Optional onKeyDownCapture#

          onKeyDownCapture? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1397

          +

          Defined in node_modules/@types/react/index.d.ts:1399


          Optional onKeyPress#

          onKeyPress? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyPress

          -

          Defined in node_modules/@types/react/index.d.ts:1398

          +

          Defined in node_modules/@types/react/index.d.ts:1400


          Optional onKeyPressCapture#

          onKeyPressCapture? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyPressCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1399

          +

          Defined in node_modules/@types/react/index.d.ts:1401


          Optional onKeyUp#

          onKeyUp? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyUp

          -

          Defined in node_modules/@types/react/index.d.ts:1400

          +

          Defined in node_modules/@types/react/index.d.ts:1402


          Optional onKeyUpCapture#

          onKeyUpCapture? : KeyboardEventHandler‹any›

          Inherited from PageLayoutProps.onKeyUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1401

          +

          Defined in node_modules/@types/react/index.d.ts:1403


          Optional onLoad#

          onLoad? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoad

          -

          Defined in node_modules/@types/react/index.d.ts:1390

          +

          Defined in node_modules/@types/react/index.d.ts:1392


          Optional onLoadCapture#

          onLoadCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1391

          +

          Defined in node_modules/@types/react/index.d.ts:1393


          Optional onLoadStart#

          onLoadStart? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadStart

          -

          Defined in node_modules/@types/react/index.d.ts:1422

          +

          Defined in node_modules/@types/react/index.d.ts:1424


          Optional onLoadStartCapture#

          onLoadStartCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1423

          +

          Defined in node_modules/@types/react/index.d.ts:1425


          Optional onLoadedData#

          onLoadedData? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadedData

          -

          Defined in node_modules/@types/react/index.d.ts:1418

          +

          Defined in node_modules/@types/react/index.d.ts:1420


          Optional onLoadedDataCapture#

          onLoadedDataCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadedDataCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1419

          +

          Defined in node_modules/@types/react/index.d.ts:1421


          Optional onLoadedMetadata#

          onLoadedMetadata? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadedMetadata

          -

          Defined in node_modules/@types/react/index.d.ts:1420

          +

          Defined in node_modules/@types/react/index.d.ts:1422


          Optional onLoadedMetadataCapture#

          onLoadedMetadataCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onLoadedMetadataCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1421

          +

          Defined in node_modules/@types/react/index.d.ts:1423


          Optional onLostPointerCapture#

          onLostPointerCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onLostPointerCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1520

          +

          Defined in node_modules/@types/react/index.d.ts:1522


          Optional onLostPointerCaptureCapture#

          onLostPointerCaptureCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onLostPointerCaptureCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1521

          +

          Defined in node_modules/@types/react/index.d.ts:1523


          Optional onMouseDown#

          onMouseDown? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseDown

          -

          Defined in node_modules/@types/react/index.d.ts:1474

          +

          Defined in node_modules/@types/react/index.d.ts:1476


          Optional onMouseDownCapture#

          onMouseDownCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1475

          +

          Defined in node_modules/@types/react/index.d.ts:1477


          Optional onMouseEnter#

          onMouseEnter? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1476

          +

          Defined in node_modules/@types/react/index.d.ts:1478


          Optional onMouseLeave#

          onMouseLeave? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1477

          +

          Defined in node_modules/@types/react/index.d.ts:1479


          Optional onMouseMove#

          onMouseMove? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseMove

          -

          Defined in node_modules/@types/react/index.d.ts:1478

          +

          Defined in node_modules/@types/react/index.d.ts:1480


          Optional onMouseMoveCapture#

          onMouseMoveCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1479

          +

          Defined in node_modules/@types/react/index.d.ts:1481


          Optional onMouseOut#

          onMouseOut? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseOut

          -

          Defined in node_modules/@types/react/index.d.ts:1480

          +

          Defined in node_modules/@types/react/index.d.ts:1482


          Optional onMouseOutCapture#

          onMouseOutCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseOutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1481

          +

          Defined in node_modules/@types/react/index.d.ts:1483


          Optional onMouseOver#

          onMouseOver? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseOver

          -

          Defined in node_modules/@types/react/index.d.ts:1482

          +

          Defined in node_modules/@types/react/index.d.ts:1484


          Optional onMouseOverCapture#

          onMouseOverCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1483

          +

          Defined in node_modules/@types/react/index.d.ts:1485


          Optional onMouseUp#

          onMouseUp? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseUp

          -

          Defined in node_modules/@types/react/index.d.ts:1484

          +

          Defined in node_modules/@types/react/index.d.ts:1486


          Optional onMouseUpCapture#

          onMouseUpCapture? : MouseEventHandler‹any›

          Inherited from PageLayoutProps.onMouseUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1485

          +

          Defined in node_modules/@types/react/index.d.ts:1487


          Optional onPaste#

          onPaste? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onPaste

          -

          Defined in node_modules/@types/react/index.d.ts:1358

          +

          Defined in node_modules/@types/react/index.d.ts:1360


          Optional onPasteCapture#

          onPasteCapture? : ClipboardEventHandler‹any›

          Inherited from PageLayoutProps.onPasteCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1359

          +

          Defined in node_modules/@types/react/index.d.ts:1361


          Optional onPause#

          onPause? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPause

          -

          Defined in node_modules/@types/react/index.d.ts:1424

          +

          Defined in node_modules/@types/react/index.d.ts:1426


          Optional onPauseCapture#

          onPauseCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPauseCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1425

          +

          Defined in node_modules/@types/react/index.d.ts:1427


          Optional onPlay#

          onPlay? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1426

          +

          Defined in node_modules/@types/react/index.d.ts:1428


          Optional onPlayCapture#

          onPlayCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPlayCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1427

          +

          Defined in node_modules/@types/react/index.d.ts:1429


          Optional onPlaying#

          onPlaying? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPlaying

          -

          Defined in node_modules/@types/react/index.d.ts:1428

          +

          Defined in node_modules/@types/react/index.d.ts:1430


          Optional onPlayingCapture#

          onPlayingCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onPlayingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1429

          +

          Defined in node_modules/@types/react/index.d.ts:1431


          Optional onPointerCancel#

          onPointerCancel? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerCancel

          -

          Defined in node_modules/@types/react/index.d.ts:1508

          +

          Defined in node_modules/@types/react/index.d.ts:1510


          Optional onPointerCancelCapture#

          onPointerCancelCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerCancelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1509

          +

          Defined in node_modules/@types/react/index.d.ts:1511


          Optional onPointerDown#

          onPointerDown? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerDown

          -

          Defined in node_modules/@types/react/index.d.ts:1502

          +

          Defined in node_modules/@types/react/index.d.ts:1504


          Optional onPointerDownCapture#

          onPointerDownCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1503

          +

          Defined in node_modules/@types/react/index.d.ts:1505


          Optional onPointerEnter#

          onPointerEnter? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1510

          +

          Defined in node_modules/@types/react/index.d.ts:1512


          Optional onPointerEnterCapture#

          onPointerEnterCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerEnterCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1511

          +

          Defined in node_modules/@types/react/index.d.ts:1513


          Optional onPointerLeave#

          onPointerLeave? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1512

          +

          Defined in node_modules/@types/react/index.d.ts:1514


          Optional onPointerLeaveCapture#

          onPointerLeaveCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerLeaveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1513

          +

          Defined in node_modules/@types/react/index.d.ts:1515


          Optional onPointerMove#

          onPointerMove? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerMove

          -

          Defined in node_modules/@types/react/index.d.ts:1504

          +

          Defined in node_modules/@types/react/index.d.ts:1506


          Optional onPointerMoveCapture#

          onPointerMoveCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1505

          +

          Defined in node_modules/@types/react/index.d.ts:1507


          Optional onPointerOut#

          onPointerOut? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerOut

          -

          Defined in node_modules/@types/react/index.d.ts:1516

          +

          Defined in node_modules/@types/react/index.d.ts:1518


          Optional onPointerOutCapture#

          onPointerOutCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerOutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1517

          +

          Defined in node_modules/@types/react/index.d.ts:1519


          Optional onPointerOver#

          onPointerOver? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerOver

          -

          Defined in node_modules/@types/react/index.d.ts:1514

          +

          Defined in node_modules/@types/react/index.d.ts:1516


          Optional onPointerOverCapture#

          onPointerOverCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1515

          +

          Defined in node_modules/@types/react/index.d.ts:1517


          Optional onPointerUp#

          onPointerUp? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerUp

          -

          Defined in node_modules/@types/react/index.d.ts:1506

          +

          Defined in node_modules/@types/react/index.d.ts:1508


          Optional onPointerUpCapture#

          onPointerUpCapture? : PointerEventHandler‹any›

          Inherited from PageLayoutProps.onPointerUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1507

          +

          Defined in node_modules/@types/react/index.d.ts:1509


          Optional onProgress#

          onProgress? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onProgress

          -

          Defined in node_modules/@types/react/index.d.ts:1430

          +

          Defined in node_modules/@types/react/index.d.ts:1432


          Optional onProgressCapture#

          onProgressCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onProgressCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1431

          +

          Defined in node_modules/@types/react/index.d.ts:1433


          Optional onRateChange#

          onRateChange? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onRateChange

          -

          Defined in node_modules/@types/react/index.d.ts:1432

          +

          Defined in node_modules/@types/react/index.d.ts:1434


          Optional onRateChangeCapture#

          onRateChangeCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onRateChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1433

          +

          Defined in node_modules/@types/react/index.d.ts:1435


          Optional onReset#

          onReset? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onReset

          -

          Defined in node_modules/@types/react/index.d.ts:1382

          +

          Defined in node_modules/@types/react/index.d.ts:1384


          Optional onResetCapture#

          onResetCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onResetCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1383

          +

          Defined in node_modules/@types/react/index.d.ts:1385


          Optional onScroll#

          onScroll? : UIEventHandler‹any›

          Inherited from PageLayoutProps.onScroll

          -

          Defined in node_modules/@types/react/index.d.ts:1524

          +

          Defined in node_modules/@types/react/index.d.ts:1526


          Optional onScrollCapture#

          onScrollCapture? : UIEventHandler‹any›

          Inherited from PageLayoutProps.onScrollCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1525

          +

          Defined in node_modules/@types/react/index.d.ts:1527


          Optional onSeeked#

          onSeeked? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSeeked

          -

          Defined in node_modules/@types/react/index.d.ts:1434

          +

          Defined in node_modules/@types/react/index.d.ts:1436


          Optional onSeekedCapture#

          onSeekedCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSeekedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1435

          +

          Defined in node_modules/@types/react/index.d.ts:1437


          Optional onSeeking#

          onSeeking? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSeeking

          -

          Defined in node_modules/@types/react/index.d.ts:1436

          +

          Defined in node_modules/@types/react/index.d.ts:1438


          Optional onSeekingCapture#

          onSeekingCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSeekingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1437

          +

          Defined in node_modules/@types/react/index.d.ts:1439


          Optional onSelect#

          onSelect? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSelect

          -

          Defined in node_modules/@types/react/index.d.ts:1488

          +

          Defined in node_modules/@types/react/index.d.ts:1490


          Optional onSelectCapture#

          onSelectCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSelectCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1489

          +

          Defined in node_modules/@types/react/index.d.ts:1491


          Optional onStalled#

          onStalled? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onStalled

          -

          Defined in node_modules/@types/react/index.d.ts:1438

          +

          Defined in node_modules/@types/react/index.d.ts:1440


          Optional onStalledCapture#

          onStalledCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onStalledCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1439

          +

          Defined in node_modules/@types/react/index.d.ts:1441


          Optional onSubmit#

          onSubmit? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onSubmit

          -

          Defined in node_modules/@types/react/index.d.ts:1384

          +

          Defined in node_modules/@types/react/index.d.ts:1386


          Optional onSubmitCapture#

          onSubmitCapture? : FormEventHandler‹any›

          Inherited from PageLayoutProps.onSubmitCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1385

          +

          Defined in node_modules/@types/react/index.d.ts:1387


          Optional onSuspend#

          onSuspend? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSuspend

          -

          Defined in node_modules/@types/react/index.d.ts:1440

          +

          Defined in node_modules/@types/react/index.d.ts:1442


          Optional onSuspendCapture#

          onSuspendCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onSuspendCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1441

          +

          Defined in node_modules/@types/react/index.d.ts:1443


          Optional onTimeUpdate#

          onTimeUpdate? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onTimeUpdate

          -

          Defined in node_modules/@types/react/index.d.ts:1442

          +

          Defined in node_modules/@types/react/index.d.ts:1444


          Optional onTimeUpdateCapture#

          onTimeUpdateCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onTimeUpdateCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1443

          +

          Defined in node_modules/@types/react/index.d.ts:1445


          Optional onTouchCancel#

          onTouchCancel? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchCancel

          -

          Defined in node_modules/@types/react/index.d.ts:1492

          +

          Defined in node_modules/@types/react/index.d.ts:1494


          Optional onTouchCancelCapture#

          onTouchCancelCapture? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchCancelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1493

          +

          Defined in node_modules/@types/react/index.d.ts:1495


          Optional onTouchEnd#

          onTouchEnd? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1494

          +

          Defined in node_modules/@types/react/index.d.ts:1496


          Optional onTouchEndCapture#

          onTouchEndCapture? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1495

          +

          Defined in node_modules/@types/react/index.d.ts:1497


          Optional onTouchMove#

          onTouchMove? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchMove

          -

          Defined in node_modules/@types/react/index.d.ts:1496

          +

          Defined in node_modules/@types/react/index.d.ts:1498


          Optional onTouchMoveCapture#

          onTouchMoveCapture? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1497

          +

          Defined in node_modules/@types/react/index.d.ts:1499


          Optional onTouchStart#

          onTouchStart? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchStart

          -

          Defined in node_modules/@types/react/index.d.ts:1498

          +

          Defined in node_modules/@types/react/index.d.ts:1500


          Optional onTouchStartCapture#

          onTouchStartCapture? : TouchEventHandler‹any›

          Inherited from PageLayoutProps.onTouchStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1499

          +

          Defined in node_modules/@types/react/index.d.ts:1501


          Optional onTransitionEnd#

          onTransitionEnd? : TransitionEventHandler‹any›

          Inherited from PageLayoutProps.onTransitionEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1540

          +

          Defined in node_modules/@types/react/index.d.ts:1542


          Optional onTransitionEndCapture#

          onTransitionEndCapture? : TransitionEventHandler‹any›

          Inherited from PageLayoutProps.onTransitionEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1541

          +

          Defined in node_modules/@types/react/index.d.ts:1543


          Optional onVolumeChange#

          onVolumeChange? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onVolumeChange

          -

          Defined in node_modules/@types/react/index.d.ts:1444

          +

          Defined in node_modules/@types/react/index.d.ts:1446


          Optional onVolumeChangeCapture#

          onVolumeChangeCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onVolumeChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1445

          +

          Defined in node_modules/@types/react/index.d.ts:1447


          Optional onWaiting#

          onWaiting? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onWaiting

          -

          Defined in node_modules/@types/react/index.d.ts:1446

          +

          Defined in node_modules/@types/react/index.d.ts:1448


          Optional onWaitingCapture#

          onWaitingCapture? : ReactEventHandler‹any›

          Inherited from PageLayoutProps.onWaitingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1447

          +

          Defined in node_modules/@types/react/index.d.ts:1449


          Optional onWheel#

          onWheel? : WheelEventHandler‹any›

          Inherited from PageLayoutProps.onWheel

          -

          Defined in node_modules/@types/react/index.d.ts:1528

          +

          Defined in node_modules/@types/react/index.d.ts:1530


          Optional onWheelCapture#

          onWheelCapture? : WheelEventHandler‹any›

          Inherited from PageLayoutProps.onWheelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1529

          +

          Defined in node_modules/@types/react/index.d.ts:1531


          Optional placeholder#

          placeholder? : string

          Inherited from ButtonProps.placeholder

          -

          Defined in node_modules/@types/react/index.d.ts:1760

          +

          Defined in node_modules/@types/react/index.d.ts:1762


          Optional prefix#

          prefix? : string

          Inherited from ButtonProps.prefix

          -

          Defined in node_modules/@types/react/index.d.ts:1778

          +

          Defined in node_modules/@types/react/index.d.ts:1780


          Optional property#

          property? : string

          Inherited from ButtonProps.property

          -

          Defined in node_modules/@types/react/index.d.ts:1779

          +

          Defined in node_modules/@types/react/index.d.ts:1781


          Optional radioGroup#

          radioGroup? : string

          Inherited from ButtonProps.radioGroup

          -

          Defined in node_modules/@types/react/index.d.ts:1769

          +

          Defined in node_modules/@types/react/index.d.ts:1771


          Optional resource#

          resource? : string

          Inherited from ButtonProps.resource

          -

          Defined in node_modules/@types/react/index.d.ts:1780

          +

          Defined in node_modules/@types/react/index.d.ts:1782


          Optional results#

          results? : number

          Inherited from ButtonProps.results

          -

          Defined in node_modules/@types/react/index.d.ts:1794

          +

          Defined in node_modules/@types/react/index.d.ts:1796


          Optional role#

          role? : string

          Inherited from ButtonProps.role

          -

          Defined in node_modules/@types/react/index.d.ts:1772

          +

          Defined in node_modules/@types/react/index.d.ts:1774


          Optional security#

          security? : string

          Inherited from ButtonProps.security

          -

          Defined in node_modules/@types/react/index.d.ts:1795

          +

          Defined in node_modules/@types/react/index.d.ts:1797


          Optional slot#

          slot? : string

          Inherited from ButtonProps.slot

          -

          Defined in node_modules/@types/react/index.d.ts:1761

          +

          Defined in node_modules/@types/react/index.d.ts:1763


          Optional spellCheck#

          spellCheck? : Booleanish

          Inherited from ButtonProps.spellCheck

          -

          Defined in node_modules/@types/react/index.d.ts:1762

          +

          Defined in node_modules/@types/react/index.d.ts:1764


          Optional style#

          style? : CSSProperties

          Inherited from ButtonProps.style

          -

          Defined in node_modules/@types/react/index.d.ts:1763

          +

          Defined in node_modules/@types/react/index.d.ts:1765


          Optional suppressContentEditableWarning#

          suppressContentEditableWarning? : boolean

          Inherited from ButtonProps.suppressContentEditableWarning

          -

          Defined in node_modules/@types/react/index.d.ts:1747

          +

          Defined in node_modules/@types/react/index.d.ts:1749


          Optional suppressHydrationWarning#

          suppressHydrationWarning? : boolean

          Inherited from ButtonProps.suppressHydrationWarning

          -

          Defined in node_modules/@types/react/index.d.ts:1748

          +

          Defined in node_modules/@types/react/index.d.ts:1750


          Optional tabIndex#

          tabIndex? : number

          Inherited from ButtonProps.tabIndex

          -

          Defined in node_modules/@types/react/index.d.ts:1764

          +

          Defined in node_modules/@types/react/index.d.ts:1766


          Optional title#

          title? : string

          Inherited from ButtonProps.title

          -

          Defined in node_modules/@types/react/index.d.ts:1765

          +

          Defined in node_modules/@types/react/index.d.ts:1767


          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"


          Optional translate#

          translate? : "yes" | "no"

          Inherited from ButtonProps.translate

          -

          Defined in node_modules/@types/react/index.d.ts:1766

          +

          Defined in node_modules/@types/react/index.d.ts:1768


          Optional typeof#

          typeof? : string

          Inherited from ButtonProps.typeof

          -

          Defined in node_modules/@types/react/index.d.ts:1781

          +

          Defined in node_modules/@types/react/index.d.ts:1783


          Optional unselectable#

          unselectable? : "on" | "off"

          Inherited from ButtonProps.unselectable

          -

          Defined in node_modules/@types/react/index.d.ts:1796

          +

          Defined in node_modules/@types/react/index.d.ts:1798


          Optional vocab#

          vocab? : string

          Inherited from ButtonProps.vocab

          -

          Defined in node_modules/@types/react/index.d.ts:1782

          +

          Defined in node_modules/@types/react/index.d.ts:1784

          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 0d5b56a60b..38cb8bdc44 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -598,7 +598,7 @@
        • - Working with mobx + Working with MobX
        • @@ -3777,244 +3777,244 @@

          Optional about#

          about? : string

          Inherited from ButtonProps.about

          -

          Defined in node_modules/@types/react/index.d.ts:1775

          +

          Defined in node_modules/@types/react/index.d.ts:1777


          Optional accept#

          accept? : string

          Inherited from LineProgressProps.accept

          -

          Defined in node_modules/@types/react/index.d.ts:1813

          +

          Defined in node_modules/@types/react/index.d.ts:1815


          Optional acceptCharset#

          acceptCharset? : string

          Inherited from LineProgressProps.acceptCharset

          -

          Defined in node_modules/@types/react/index.d.ts:1814

          +

          Defined in node_modules/@types/react/index.d.ts:1816


          Optional accessKey#

          accessKey? : string

          Inherited from ButtonProps.accessKey

          -

          Defined in node_modules/@types/react/index.d.ts:1751

          +

          Defined in node_modules/@types/react/index.d.ts:1753


          Optional action#

          action? : string

          Inherited from LineProgressProps.action

          -

          Defined in node_modules/@types/react/index.d.ts:1815

          +

          Defined in node_modules/@types/react/index.d.ts:1817


          Optional allowFullScreen#

          allowFullScreen? : boolean

          Inherited from LineProgressProps.allowFullScreen

          -

          Defined in node_modules/@types/react/index.d.ts:1816

          +

          Defined in node_modules/@types/react/index.d.ts:1818


          Optional allowTransparency#

          allowTransparency? : boolean

          Inherited from LineProgressProps.allowTransparency

          -

          Defined in node_modules/@types/react/index.d.ts:1817

          +

          Defined in node_modules/@types/react/index.d.ts:1819


          Optional alt#

          alt? : string

          Inherited from LineProgressProps.alt

          -

          Defined in node_modules/@types/react/index.d.ts:1818

          +

          Defined in node_modules/@types/react/index.d.ts:1820


          Optional aria-activedescendant#

          aria-activedescendant? : string

          Inherited from ButtonProps.aria-activedescendant

          -

          Defined in node_modules/@types/react/index.d.ts:1558

          +

          Defined in node_modules/@types/react/index.d.ts:1560

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1562

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1567

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1569

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1574

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1579

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1584

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1589

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1594

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1596

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1601

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1606

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1611

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1616

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1621

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1623

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1628

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1633

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1635

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1640

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1645

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1647

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1652

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1657

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1659

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1661

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1663

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1665

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1667

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1669

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1675

          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.

          @@ -4022,255 +4022,255 @@ between DOM elements where the DOM hierarchy cannot be used to represent the rel

          Optional aria-placeholder#

          aria-placeholder? : string

          Inherited from ButtonProps.aria-placeholder

          -

          Defined in node_modules/@types/react/index.d.ts:1678

          +

          Defined in node_modules/@types/react/index.d.ts:1680

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1685

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1690

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1695

          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"

          +

          aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

          Inherited from ButtonProps.aria-relevant

          -

          Defined in node_modules/@types/react/index.d.ts:1698

          +

          Defined in node_modules/@types/react/index.d.ts:1700

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1702

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1704

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1709

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1714

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1719

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1724

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1729

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1731

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1733

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1735

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1740

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1742

          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

          +

          Defined in node_modules/@types/react/index.d.ts:1821


          Optional async#

          async? : boolean

          Inherited from LineProgressProps.async

          -

          Defined in node_modules/@types/react/index.d.ts:1820

          +

          Defined in node_modules/@types/react/index.d.ts:1822


          Optional autoCapitalize#

          autoCapitalize? : string

          Inherited from ButtonProps.autoCapitalize

          -

          Defined in node_modules/@types/react/index.d.ts:1785

          +

          Defined in node_modules/@types/react/index.d.ts:1787


          Optional autoComplete#

          autoComplete? : string

          Inherited from LineProgressProps.autoComplete

          -

          Defined in node_modules/@types/react/index.d.ts:1821

          +

          Defined in node_modules/@types/react/index.d.ts:1823


          Optional autoCorrect#

          autoCorrect? : string

          Inherited from ButtonProps.autoCorrect

          -

          Defined in node_modules/@types/react/index.d.ts:1786

          +

          Defined in node_modules/@types/react/index.d.ts:1788


          Optional autoFocus#

          autoFocus? : boolean

          Inherited from LineProgressProps.autoFocus

          -

          Defined in node_modules/@types/react/index.d.ts:1822

          +

          Defined in node_modules/@types/react/index.d.ts:1824


          Optional autoPlay#

          autoPlay? : boolean

          Inherited from LineProgressProps.autoPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1823

          +

          Defined in node_modules/@types/react/index.d.ts:1825


          Optional autoSave#

          autoSave? : string

          Inherited from ButtonProps.autoSave

          -

          Defined in node_modules/@types/react/index.d.ts:1787

          +

          Defined in node_modules/@types/react/index.d.ts:1789


          Optional capture#

          capture? : boolean | string

          Inherited from LineProgressProps.capture

          -

          Defined in node_modules/@types/react/index.d.ts:1824

          +

          Defined in node_modules/@types/react/index.d.ts:1826


          Optional cellPadding#

          cellPadding? : number | string

          Inherited from LineProgressProps.cellPadding

          -

          Defined in node_modules/@types/react/index.d.ts:1825

          +

          Defined in node_modules/@types/react/index.d.ts:1827


          Optional cellSpacing#

          cellSpacing? : number | string

          Inherited from LineProgressProps.cellSpacing

          -

          Defined in node_modules/@types/react/index.d.ts:1826

          +

          Defined in node_modules/@types/react/index.d.ts:1828


          Optional challenge#

          challenge? : string

          Inherited from LineProgressProps.challenge

          -

          Defined in node_modules/@types/react/index.d.ts:1828

          +

          Defined in node_modules/@types/react/index.d.ts:1830


          Optional charSet#

          charSet? : string

          Inherited from LineProgressProps.charSet

          -

          Defined in node_modules/@types/react/index.d.ts:1827

          +

          Defined in node_modules/@types/react/index.d.ts:1829


          Optional checked#

          checked? : boolean

          Inherited from LineProgressProps.checked

          -

          Defined in node_modules/@types/react/index.d.ts:1829

          +

          Defined in node_modules/@types/react/index.d.ts:1831


          Optional children#

          children? : ReactNode

          Inherited from PageLayoutProps.children

          -

          Defined in node_modules/@types/react/index.d.ts:1348

          +

          Defined in node_modules/@types/react/index.d.ts:1350


          Optional cite#

          cite? : string

          Inherited from LineProgressProps.cite

          -

          Defined in node_modules/@types/react/index.d.ts:1830

          +

          Defined in node_modules/@types/react/index.d.ts:1832


          Optional classID#

          classID? : string

          Inherited from LineProgressProps.classID

          -

          Defined in node_modules/@types/react/index.d.ts:1831

          +

          Defined in node_modules/@types/react/index.d.ts:1833


          Optional className#

          className? : string

          Inherited from ButtonProps.className

          -

          Defined in node_modules/@types/react/index.d.ts:1752

          +

          Defined in node_modules/@types/react/index.d.ts:1754


          Optional colSpan#

          colSpan? : number

          Inherited from LineProgressProps.colSpan

          -

          Defined in node_modules/@types/react/index.d.ts:1833

          +

          Defined in node_modules/@types/react/index.d.ts:1835


          Optional color#

          color? : string

          Inherited from ButtonProps.color

          -

          Defined in node_modules/@types/react/index.d.ts:1788

          +

          Defined in node_modules/@types/react/index.d.ts:1790


          Optional cols#

          cols? : number

          Inherited from LineProgressProps.cols

          -

          Defined in node_modules/@types/react/index.d.ts:1832

          +

          Defined in node_modules/@types/react/index.d.ts:1834


          Optional content#

          content? : string

          Inherited from LineProgressProps.content

          -

          Defined in node_modules/@types/react/index.d.ts:1834

          +

          Defined in node_modules/@types/react/index.d.ts:1836


          Optional contentEditable#

          contentEditable? : Booleanish | "inherit"

          Inherited from ButtonProps.contentEditable

          -

          Defined in node_modules/@types/react/index.d.ts:1753

          +

          Defined in node_modules/@types/react/index.d.ts:1755


          Optional contextMenu#

          contextMenu? : string

          Inherited from ButtonProps.contextMenu

          -

          Defined in node_modules/@types/react/index.d.ts:1754

          +

          Defined in node_modules/@types/react/index.d.ts:1756


          Optional controls#

          controls? : boolean

          Inherited from LineProgressProps.controls

          -

          Defined in node_modules/@types/react/index.d.ts:1835

          +

          Defined in node_modules/@types/react/index.d.ts:1837


          Optional coords#

          coords? : string

          Inherited from LineProgressProps.coords

          -

          Defined in node_modules/@types/react/index.d.ts:1836

          +

          Defined in node_modules/@types/react/index.d.ts:1838


          Optional crossOrigin#

          crossOrigin? : string

          Inherited from LineProgressProps.crossOrigin

          -

          Defined in node_modules/@types/react/index.d.ts:1837

          +

          Defined in node_modules/@types/react/index.d.ts:1839


          Optional dangerouslySetInnerHTML#

          dangerouslySetInnerHTML? : object

          Inherited from PageLayoutProps.dangerouslySetInnerHTML

          -

          Defined in node_modules/@types/react/index.d.ts:1349

          +

          Defined in node_modules/@types/react/index.d.ts:1351

          Type declaration:

          • __html: string
          • @@ -4279,1396 +4279,1396 @@ A hint could be a sample value or a brief description of the expected format.

            Optional data#

            data? : string

            Inherited from LineProgressProps.data

            -

            Defined in node_modules/@types/react/index.d.ts:1838

            +

            Defined in node_modules/@types/react/index.d.ts:1840


            Optional datatype#

            datatype? : string

            Inherited from ButtonProps.datatype

            -

            Defined in node_modules/@types/react/index.d.ts:1776

            +

            Defined in node_modules/@types/react/index.d.ts:1778


            Optional dateTime#

            dateTime? : string

            Inherited from LineProgressProps.dateTime

            -

            Defined in node_modules/@types/react/index.d.ts:1839

            +

            Defined in node_modules/@types/react/index.d.ts:1841


            Optional default#

            default? : boolean

            Inherited from LineProgressProps.default

            -

            Defined in node_modules/@types/react/index.d.ts:1840

            +

            Defined in node_modules/@types/react/index.d.ts:1842


            Optional defaultChecked#

            defaultChecked? : boolean

            Inherited from ButtonProps.defaultChecked

            -

            Defined in node_modules/@types/react/index.d.ts:1745

            +

            Defined in node_modules/@types/react/index.d.ts:1747


            Optional defaultValue#

            -

            defaultValue? : string | number | string[]

            +

            defaultValue? : string | number | ReadonlyArray‹string›

            Inherited from ButtonProps.defaultValue

            -

            Defined in node_modules/@types/react/index.d.ts:1746

            +

            Defined in node_modules/@types/react/index.d.ts:1748


            Optional defer#

            defer? : boolean

            Inherited from LineProgressProps.defer

            -

            Defined in node_modules/@types/react/index.d.ts:1841

            +

            Defined in node_modules/@types/react/index.d.ts:1843


            Optional dir#

            dir? : string

            Inherited from ButtonProps.dir

            -

            Defined in node_modules/@types/react/index.d.ts:1755

            +

            Defined in node_modules/@types/react/index.d.ts:1757


            Optional disabled#

            disabled? : boolean

            Inherited from LineProgressProps.disabled

            -

            Defined in node_modules/@types/react/index.d.ts:1842

            +

            Defined in node_modules/@types/react/index.d.ts:1844


            Optional download#

            download? : any

            Inherited from LineProgressProps.download

            -

            Defined in node_modules/@types/react/index.d.ts:1843

            +

            Defined in node_modules/@types/react/index.d.ts:1845


            Optional draggable#

            draggable? : Booleanish

            Inherited from ButtonProps.draggable

            -

            Defined in node_modules/@types/react/index.d.ts:1756

            +

            Defined in node_modules/@types/react/index.d.ts:1758


            Optional encType#

            encType? : string

            Inherited from LineProgressProps.encType

            -

            Defined in node_modules/@types/react/index.d.ts:1844

            +

            Defined in node_modules/@types/react/index.d.ts:1846


            Optional form#

            form? : string

            Inherited from LineProgressProps.form

            -

            Defined in node_modules/@types/react/index.d.ts:1845

            +

            Defined in node_modules/@types/react/index.d.ts:1847


            Optional formAction#

            formAction? : string

            Inherited from LineProgressProps.formAction

            -

            Defined in node_modules/@types/react/index.d.ts:1846

            +

            Defined in node_modules/@types/react/index.d.ts:1848


            Optional formEncType#

            formEncType? : string

            Inherited from LineProgressProps.formEncType

            -

            Defined in node_modules/@types/react/index.d.ts:1847

            +

            Defined in node_modules/@types/react/index.d.ts:1849


            Optional formMethod#

            formMethod? : string

            Inherited from LineProgressProps.formMethod

            -

            Defined in node_modules/@types/react/index.d.ts:1848

            +

            Defined in node_modules/@types/react/index.d.ts:1850


            Optional formNoValidate#

            formNoValidate? : boolean

            Inherited from LineProgressProps.formNoValidate

            -

            Defined in node_modules/@types/react/index.d.ts:1849

            +

            Defined in node_modules/@types/react/index.d.ts:1851


            Optional formTarget#

            formTarget? : string

            Inherited from LineProgressProps.formTarget

            -

            Defined in node_modules/@types/react/index.d.ts:1850

            +

            Defined in node_modules/@types/react/index.d.ts:1852


            Optional frameBorder#

            frameBorder? : number | string

            Inherited from LineProgressProps.frameBorder

            -

            Defined in node_modules/@types/react/index.d.ts:1851

            +

            Defined in node_modules/@types/react/index.d.ts:1853


            Optional headers#

            headers? : string

            Inherited from LineProgressProps.headers

            -

            Defined in node_modules/@types/react/index.d.ts:1852

            +

            Defined in node_modules/@types/react/index.d.ts:1854


            Optional height#

            height? : number | string

            Inherited from LineProgressProps.height

            -

            Defined in node_modules/@types/react/index.d.ts:1853

            +

            Defined in node_modules/@types/react/index.d.ts:1855


            Optional hidden#

            hidden? : boolean

            Inherited from IconProps.hidden

            -

            Defined in node_modules/@types/react/index.d.ts:1757

            +

            Defined in node_modules/@types/react/index.d.ts:1759


            Optional high#

            high? : number

            Inherited from LineProgressProps.high

            -

            Defined in node_modules/@types/react/index.d.ts:1854

            +

            Defined in node_modules/@types/react/index.d.ts:1856


            Optional href#

            href? : string

            Inherited from LineProgressProps.href

            -

            Defined in node_modules/@types/react/index.d.ts:1855

            +

            Defined in node_modules/@types/react/index.d.ts:1857


            Optional hrefLang#

            hrefLang? : string

            Inherited from LineProgressProps.hrefLang

            -

            Defined in node_modules/@types/react/index.d.ts:1856

            +

            Defined in node_modules/@types/react/index.d.ts:1858


            Optional htmlFor#

            htmlFor? : string

            Inherited from LineProgressProps.htmlFor

            -

            Defined in node_modules/@types/react/index.d.ts:1857

            +

            Defined in node_modules/@types/react/index.d.ts:1859


            Optional httpEquiv#

            httpEquiv? : string

            Inherited from LineProgressProps.httpEquiv

            -

            Defined in node_modules/@types/react/index.d.ts:1858

            +

            Defined in node_modules/@types/react/index.d.ts:1860


            Optional id#

            id? : string

            Inherited from ButtonProps.id

            -

            Defined in node_modules/@types/react/index.d.ts:1758

            +

            Defined in node_modules/@types/react/index.d.ts:1760


            Optional inlist#

            inlist? : any

            Inherited from ButtonProps.inlist

            -

            Defined in node_modules/@types/react/index.d.ts:1777

            +

            Defined in node_modules/@types/react/index.d.ts:1779


            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

            +

            Defined in node_modules/@types/react/index.d.ts:1805

            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

            +

            Defined in node_modules/@types/react/index.d.ts:1861


            Optional is#

            is? : string

            Inherited from ButtonProps.is

            -

            Defined in node_modules/@types/react/index.d.ts:1808

            +

            Defined in node_modules/@types/react/index.d.ts:1810

            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

            +

            Defined in node_modules/@types/react/index.d.ts:1794


            Optional itemProp#

            itemProp? : string

            Inherited from ButtonProps.itemProp

            -

            Defined in node_modules/@types/react/index.d.ts:1789

            +

            Defined in node_modules/@types/react/index.d.ts:1791


            Optional itemRef#

            itemRef? : string

            Inherited from ButtonProps.itemRef

            -

            Defined in node_modules/@types/react/index.d.ts:1793

            +

            Defined in node_modules/@types/react/index.d.ts:1795


            Optional itemScope#

            itemScope? : boolean

            Inherited from ButtonProps.itemScope

            -

            Defined in node_modules/@types/react/index.d.ts:1790

            +

            Defined in node_modules/@types/react/index.d.ts:1792


            Optional itemType#

            itemType? : string

            Inherited from ButtonProps.itemType

            -

            Defined in node_modules/@types/react/index.d.ts:1791

            +

            Defined in node_modules/@types/react/index.d.ts:1793


            Optional key#

            -

            key? : Key

            +

            key? : Key | null

            Inherited from LineProgressProps.key

            -

            Defined in node_modules/@types/react/index.d.ts:139

            +

            Defined in node_modules/@types/react/index.d.ts:137


            Optional keyParams#

            keyParams? : string

            Inherited from LineProgressProps.keyParams

            -

            Defined in node_modules/@types/react/index.d.ts:1860

            +

            Defined in node_modules/@types/react/index.d.ts:1862


            Optional keyType#

            keyType? : string

            Inherited from LineProgressProps.keyType

            -

            Defined in node_modules/@types/react/index.d.ts:1861

            +

            Defined in node_modules/@types/react/index.d.ts:1863


            Optional kind#

            kind? : string

            Inherited from LineProgressProps.kind

            -

            Defined in node_modules/@types/react/index.d.ts:1862

            +

            Defined in node_modules/@types/react/index.d.ts:1864


            Optional label#

            label? : string

            Inherited from LineProgressProps.label

            -

            Defined in node_modules/@types/react/index.d.ts:1863

            +

            Defined in node_modules/@types/react/index.d.ts:1865


            Optional lang#

            lang? : string

            Inherited from ButtonProps.lang

            -

            Defined in node_modules/@types/react/index.d.ts:1759

            +

            Defined in node_modules/@types/react/index.d.ts:1761


            Optional list#

            list? : string

            Inherited from LineProgressProps.list

            -

            Defined in node_modules/@types/react/index.d.ts:1864

            +

            Defined in node_modules/@types/react/index.d.ts:1866


            Optional loop#

            loop? : boolean

            Inherited from LineProgressProps.loop

            -

            Defined in node_modules/@types/react/index.d.ts:1865

            +

            Defined in node_modules/@types/react/index.d.ts:1867


            Optional low#

            low? : number

            Inherited from LineProgressProps.low

            -

            Defined in node_modules/@types/react/index.d.ts:1866

            +

            Defined in node_modules/@types/react/index.d.ts:1868


            Optional manifest#

            manifest? : string

            Inherited from LineProgressProps.manifest

            -

            Defined in node_modules/@types/react/index.d.ts:1867

            +

            Defined in node_modules/@types/react/index.d.ts:1869


            Optional marginHeight#

            marginHeight? : number

            Inherited from LineProgressProps.marginHeight

            -

            Defined in node_modules/@types/react/index.d.ts:1868

            +

            Defined in node_modules/@types/react/index.d.ts:1870


            Optional marginWidth#

            marginWidth? : number

            Inherited from LineProgressProps.marginWidth

            -

            Defined in node_modules/@types/react/index.d.ts:1869

            +

            Defined in node_modules/@types/react/index.d.ts:1871


            Optional max#

            max? : number | string

            Inherited from MenuItemProps.max

            -

            Defined in node_modules/@types/react/index.d.ts:1870

            +

            Defined in node_modules/@types/react/index.d.ts:1872


            Optional maxLength#

            maxLength? : number

            Inherited from LineProgressProps.maxLength

            -

            Defined in node_modules/@types/react/index.d.ts:1871

            +

            Defined in node_modules/@types/react/index.d.ts:1873


            Optional media#

            media? : string

            Inherited from LineProgressProps.media

            -

            Defined in node_modules/@types/react/index.d.ts:1872

            +

            Defined in node_modules/@types/react/index.d.ts:1874


            Optional mediaGroup#

            mediaGroup? : string

            Inherited from LineProgressProps.mediaGroup

            -

            Defined in node_modules/@types/react/index.d.ts:1873

            +

            Defined in node_modules/@types/react/index.d.ts:1875


            Optional method#

            method? : string

            Inherited from LineProgressProps.method

            -

            Defined in node_modules/@types/react/index.d.ts:1874

            +

            Defined in node_modules/@types/react/index.d.ts:1876


            Optional min#

            min? : number | string

            Inherited from MenuItemProps.min

            -

            Defined in node_modules/@types/react/index.d.ts:1875

            +

            Defined in node_modules/@types/react/index.d.ts:1877


            Optional minLength#

            minLength? : number

            Inherited from LineProgressProps.minLength

            -

            Defined in node_modules/@types/react/index.d.ts:1876

            +

            Defined in node_modules/@types/react/index.d.ts:1878


            Optional multiple#

            multiple? : boolean

            Inherited from LineProgressProps.multiple

            -

            Defined in node_modules/@types/react/index.d.ts:1877

            +

            Defined in node_modules/@types/react/index.d.ts:1879


            Optional muted#

            muted? : boolean

            Inherited from LineProgressProps.muted

            -

            Defined in node_modules/@types/react/index.d.ts:1878

            +

            Defined in node_modules/@types/react/index.d.ts:1880


            Optional name#

            name? : string

            Inherited from LineProgressProps.name

            -

            Defined in node_modules/@types/react/index.d.ts:1879

            +

            Defined in node_modules/@types/react/index.d.ts:1881


            Optional noValidate#

            noValidate? : boolean

            Inherited from LineProgressProps.noValidate

            -

            Defined in node_modules/@types/react/index.d.ts:1881

            +

            Defined in node_modules/@types/react/index.d.ts:1883


            Optional nonce#

            nonce? : string

            Inherited from LineProgressProps.nonce

            -

            Defined in node_modules/@types/react/index.d.ts:1880

            +

            Defined in node_modules/@types/react/index.d.ts:1882


            Optional onAbort#

            onAbort? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onAbort

            -

            Defined in node_modules/@types/react/index.d.ts:1404

            +

            Defined in node_modules/@types/react/index.d.ts:1406


            Optional onAbortCapture#

            onAbortCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onAbortCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1405

            +

            Defined in node_modules/@types/react/index.d.ts:1407


            Optional onAnimationEnd#

            onAnimationEnd? : AnimationEventHandler‹any›

            Inherited from PageLayoutProps.onAnimationEnd

            -

            Defined in node_modules/@types/react/index.d.ts:1534

            +

            Defined in node_modules/@types/react/index.d.ts:1536


            Optional onAnimationEndCapture#

            onAnimationEndCapture? : AnimationEventHandler‹any›

            Inherited from PageLayoutProps.onAnimationEndCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1535

            +

            Defined in node_modules/@types/react/index.d.ts:1537


            Optional onAnimationIteration#

            onAnimationIteration? : AnimationEventHandler‹any›

            Inherited from PageLayoutProps.onAnimationIteration

            -

            Defined in node_modules/@types/react/index.d.ts:1536

            +

            Defined in node_modules/@types/react/index.d.ts:1538


            Optional onAnimationIterationCapture#

            onAnimationIterationCapture? : AnimationEventHandler‹any›

            Inherited from PageLayoutProps.onAnimationIterationCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1537

            +

            Defined in node_modules/@types/react/index.d.ts:1539


            Optional onAnimationStart#

            onAnimationStart? : AnimationEventHandler‹any›

            Inherited from PageLayoutProps.onAnimationStart

            -

            Defined in node_modules/@types/react/index.d.ts:1532

            +

            Defined in node_modules/@types/react/index.d.ts:1534


            Optional onAnimationStartCapture#

            onAnimationStartCapture? : AnimationEventHandler‹any›

            Inherited from PageLayoutProps.onAnimationStartCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1533

            +

            Defined in node_modules/@types/react/index.d.ts:1535


            Optional onAuxClick#

            onAuxClick? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onAuxClick

            -

            Defined in node_modules/@types/react/index.d.ts:1450

            +

            Defined in node_modules/@types/react/index.d.ts:1452


            Optional onAuxClickCapture#

            onAuxClickCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onAuxClickCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1451

            +

            Defined in node_modules/@types/react/index.d.ts:1453


            Optional onBeforeInput#

            onBeforeInput? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onBeforeInput

            -

            Defined in node_modules/@types/react/index.d.ts:1378

            +

            Defined in node_modules/@types/react/index.d.ts:1380


            Optional onBeforeInputCapture#

            onBeforeInputCapture? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onBeforeInputCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1379

            +

            Defined in node_modules/@types/react/index.d.ts:1381


            Optional onBlur#

            onBlur? : FocusEventHandler‹any›

            Inherited from PageLayoutProps.onBlur

            -

            Defined in node_modules/@types/react/index.d.ts:1372

            +

            Defined in node_modules/@types/react/index.d.ts:1374


            Optional onBlurCapture#

            onBlurCapture? : FocusEventHandler‹any›

            Inherited from PageLayoutProps.onBlurCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1373

            +

            Defined in node_modules/@types/react/index.d.ts:1375


            Optional onCanPlay#

            onCanPlay? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onCanPlay

            -

            Defined in node_modules/@types/react/index.d.ts:1406

            +

            Defined in node_modules/@types/react/index.d.ts:1408


            Optional onCanPlayCapture#

            onCanPlayCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onCanPlayCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1407

            +

            Defined in node_modules/@types/react/index.d.ts:1409


            Optional onCanPlayThrough#

            onCanPlayThrough? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onCanPlayThrough

            -

            Defined in node_modules/@types/react/index.d.ts:1408

            +

            Defined in node_modules/@types/react/index.d.ts:1410


            Optional onCanPlayThroughCapture#

            onCanPlayThroughCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onCanPlayThroughCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1409

            +

            Defined in node_modules/@types/react/index.d.ts:1411


            Optional onChange#

            onChange? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onChange

            -

            Defined in node_modules/@types/react/index.d.ts:1376

            +

            Defined in node_modules/@types/react/index.d.ts:1378


            Optional onChangeCapture#

            onChangeCapture? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onChangeCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1377

            +

            Defined in node_modules/@types/react/index.d.ts:1379


            Optional onClick#

            onClick? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onClick

            -

            Defined in node_modules/@types/react/index.d.ts:1452

            +

            Defined in node_modules/@types/react/index.d.ts:1454


            Optional onClickCapture#

            onClickCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onClickCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1453

            +

            Defined in node_modules/@types/react/index.d.ts:1455


            Optional onCompositionEnd#

            onCompositionEnd? : CompositionEventHandler‹any›

            Inherited from PageLayoutProps.onCompositionEnd

            -

            Defined in node_modules/@types/react/index.d.ts:1362

            +

            Defined in node_modules/@types/react/index.d.ts:1364


            Optional onCompositionEndCapture#

            onCompositionEndCapture? : CompositionEventHandler‹any›

            Inherited from PageLayoutProps.onCompositionEndCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1363

            +

            Defined in node_modules/@types/react/index.d.ts:1365


            Optional onCompositionStart#

            onCompositionStart? : CompositionEventHandler‹any›

            Inherited from PageLayoutProps.onCompositionStart

            -

            Defined in node_modules/@types/react/index.d.ts:1364

            +

            Defined in node_modules/@types/react/index.d.ts:1366


            Optional onCompositionStartCapture#

            onCompositionStartCapture? : CompositionEventHandler‹any›

            Inherited from PageLayoutProps.onCompositionStartCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1365

            +

            Defined in node_modules/@types/react/index.d.ts:1367


            Optional onCompositionUpdate#

            onCompositionUpdate? : CompositionEventHandler‹any›

            Inherited from PageLayoutProps.onCompositionUpdate

            -

            Defined in node_modules/@types/react/index.d.ts:1366

            +

            Defined in node_modules/@types/react/index.d.ts:1368


            Optional onCompositionUpdateCapture#

            onCompositionUpdateCapture? : CompositionEventHandler‹any›

            Inherited from PageLayoutProps.onCompositionUpdateCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1367

            +

            Defined in node_modules/@types/react/index.d.ts:1369


            Optional onContextMenu#

            onContextMenu? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onContextMenu

            -

            Defined in node_modules/@types/react/index.d.ts:1454

            +

            Defined in node_modules/@types/react/index.d.ts:1456


            Optional onContextMenuCapture#

            onContextMenuCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onContextMenuCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1455

            +

            Defined in node_modules/@types/react/index.d.ts:1457


            Optional onCopy#

            onCopy? : ClipboardEventHandler‹any›

            Inherited from PageLayoutProps.onCopy

            -

            Defined in node_modules/@types/react/index.d.ts:1354

            +

            Defined in node_modules/@types/react/index.d.ts:1356


            Optional onCopyCapture#

            onCopyCapture? : ClipboardEventHandler‹any›

            Inherited from PageLayoutProps.onCopyCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1355

            +

            Defined in node_modules/@types/react/index.d.ts:1357


            Optional onCut#

            onCut? : ClipboardEventHandler‹any›

            Inherited from PageLayoutProps.onCut

            -

            Defined in node_modules/@types/react/index.d.ts:1356

            +

            Defined in node_modules/@types/react/index.d.ts:1358


            Optional onCutCapture#

            onCutCapture? : ClipboardEventHandler‹any›

            Inherited from PageLayoutProps.onCutCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1357

            +

            Defined in node_modules/@types/react/index.d.ts:1359


            Optional onDoubleClick#

            onDoubleClick? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onDoubleClick

            -

            Defined in node_modules/@types/react/index.d.ts:1456

            +

            Defined in node_modules/@types/react/index.d.ts:1458


            Optional onDoubleClickCapture#

            onDoubleClickCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onDoubleClickCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1457

            +

            Defined in node_modules/@types/react/index.d.ts:1459


            Optional onDrag#

            onDrag? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDrag

            -

            Defined in node_modules/@types/react/index.d.ts:1458

            +

            Defined in node_modules/@types/react/index.d.ts:1460


            Optional onDragCapture#

            onDragCapture? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1459

            +

            Defined in node_modules/@types/react/index.d.ts:1461


            Optional onDragEnd#

            onDragEnd? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragEnd

            -

            Defined in node_modules/@types/react/index.d.ts:1460

            +

            Defined in node_modules/@types/react/index.d.ts:1462


            Optional onDragEndCapture#

            onDragEndCapture? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragEndCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1461

            +

            Defined in node_modules/@types/react/index.d.ts:1463


            Optional onDragEnter#

            onDragEnter? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragEnter

            -

            Defined in node_modules/@types/react/index.d.ts:1462

            +

            Defined in node_modules/@types/react/index.d.ts:1464


            Optional onDragEnterCapture#

            onDragEnterCapture? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragEnterCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1463

            +

            Defined in node_modules/@types/react/index.d.ts:1465


            Optional onDragExit#

            onDragExit? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragExit

            -

            Defined in node_modules/@types/react/index.d.ts:1464

            +

            Defined in node_modules/@types/react/index.d.ts:1466


            Optional onDragExitCapture#

            onDragExitCapture? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragExitCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1465

            +

            Defined in node_modules/@types/react/index.d.ts:1467


            Optional onDragLeave#

            onDragLeave? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragLeave

            -

            Defined in node_modules/@types/react/index.d.ts:1466

            +

            Defined in node_modules/@types/react/index.d.ts:1468


            Optional onDragLeaveCapture#

            onDragLeaveCapture? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragLeaveCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1467

            +

            Defined in node_modules/@types/react/index.d.ts:1469


            Optional onDragOver#

            onDragOver? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragOver

            -

            Defined in node_modules/@types/react/index.d.ts:1468

            +

            Defined in node_modules/@types/react/index.d.ts:1470


            Optional onDragOverCapture#

            onDragOverCapture? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragOverCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1469

            +

            Defined in node_modules/@types/react/index.d.ts:1471


            Optional onDragStart#

            onDragStart? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragStart

            -

            Defined in node_modules/@types/react/index.d.ts:1470

            +

            Defined in node_modules/@types/react/index.d.ts:1472


            Optional onDragStartCapture#

            onDragStartCapture? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDragStartCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1471

            +

            Defined in node_modules/@types/react/index.d.ts:1473


            Optional onDrop#

            onDrop? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDrop

            -

            Defined in node_modules/@types/react/index.d.ts:1472

            +

            Defined in node_modules/@types/react/index.d.ts:1474


            Optional onDropCapture#

            onDropCapture? : DragEventHandler‹any›

            Inherited from PageLayoutProps.onDropCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1473

            +

            Defined in node_modules/@types/react/index.d.ts:1475


            Optional onDurationChange#

            onDurationChange? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onDurationChange

            -

            Defined in node_modules/@types/react/index.d.ts:1410

            +

            Defined in node_modules/@types/react/index.d.ts:1412


            Optional onDurationChangeCapture#

            onDurationChangeCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onDurationChangeCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1411

            +

            Defined in node_modules/@types/react/index.d.ts:1413


            Optional onEmptied#

            onEmptied? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onEmptied

            -

            Defined in node_modules/@types/react/index.d.ts:1412

            +

            Defined in node_modules/@types/react/index.d.ts:1414


            Optional onEmptiedCapture#

            onEmptiedCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onEmptiedCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1413

            +

            Defined in node_modules/@types/react/index.d.ts:1415


            Optional onEncrypted#

            onEncrypted? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onEncrypted

            -

            Defined in node_modules/@types/react/index.d.ts:1414

            +

            Defined in node_modules/@types/react/index.d.ts:1416


            Optional onEncryptedCapture#

            onEncryptedCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onEncryptedCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1415

            +

            Defined in node_modules/@types/react/index.d.ts:1417


            Optional onEnded#

            onEnded? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onEnded

            -

            Defined in node_modules/@types/react/index.d.ts:1416

            +

            Defined in node_modules/@types/react/index.d.ts:1418


            Optional onEndedCapture#

            onEndedCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onEndedCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1417

            +

            Defined in node_modules/@types/react/index.d.ts:1419


            Optional onError#

            onError? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onError

            -

            Defined in node_modules/@types/react/index.d.ts:1392

            +

            Defined in node_modules/@types/react/index.d.ts:1394


            Optional onErrorCapture#

            onErrorCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onErrorCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1393

            +

            Defined in node_modules/@types/react/index.d.ts:1395


            Optional onFocus#

            onFocus? : FocusEventHandler‹any›

            Inherited from PageLayoutProps.onFocus

            -

            Defined in node_modules/@types/react/index.d.ts:1370

            +

            Defined in node_modules/@types/react/index.d.ts:1372


            Optional onFocusCapture#

            onFocusCapture? : FocusEventHandler‹any›

            Inherited from PageLayoutProps.onFocusCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1371

            +

            Defined in node_modules/@types/react/index.d.ts:1373


            Optional onGotPointerCapture#

            onGotPointerCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onGotPointerCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1518

            +

            Defined in node_modules/@types/react/index.d.ts:1520


            Optional onGotPointerCaptureCapture#

            onGotPointerCaptureCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onGotPointerCaptureCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1519

            +

            Defined in node_modules/@types/react/index.d.ts:1521


            Optional onInput#

            onInput? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onInput

            -

            Defined in node_modules/@types/react/index.d.ts:1380

            +

            Defined in node_modules/@types/react/index.d.ts:1382


            Optional onInputCapture#

            onInputCapture? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onInputCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1381

            +

            Defined in node_modules/@types/react/index.d.ts:1383


            Optional onInvalid#

            onInvalid? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onInvalid

            -

            Defined in node_modules/@types/react/index.d.ts:1386

            +

            Defined in node_modules/@types/react/index.d.ts:1388


            Optional onInvalidCapture#

            onInvalidCapture? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onInvalidCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1387

            +

            Defined in node_modules/@types/react/index.d.ts:1389


            Optional onKeyDown#

            onKeyDown? : KeyboardEventHandler‹any›

            Inherited from PageLayoutProps.onKeyDown

            -

            Defined in node_modules/@types/react/index.d.ts:1396

            +

            Defined in node_modules/@types/react/index.d.ts:1398


            Optional onKeyDownCapture#

            onKeyDownCapture? : KeyboardEventHandler‹any›

            Inherited from PageLayoutProps.onKeyDownCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1397

            +

            Defined in node_modules/@types/react/index.d.ts:1399


            Optional onKeyPress#

            onKeyPress? : KeyboardEventHandler‹any›

            Inherited from PageLayoutProps.onKeyPress

            -

            Defined in node_modules/@types/react/index.d.ts:1398

            +

            Defined in node_modules/@types/react/index.d.ts:1400


            Optional onKeyPressCapture#

            onKeyPressCapture? : KeyboardEventHandler‹any›

            Inherited from PageLayoutProps.onKeyPressCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1399

            +

            Defined in node_modules/@types/react/index.d.ts:1401


            Optional onKeyUp#

            onKeyUp? : KeyboardEventHandler‹any›

            Inherited from PageLayoutProps.onKeyUp

            -

            Defined in node_modules/@types/react/index.d.ts:1400

            +

            Defined in node_modules/@types/react/index.d.ts:1402


            Optional onKeyUpCapture#

            onKeyUpCapture? : KeyboardEventHandler‹any›

            Inherited from PageLayoutProps.onKeyUpCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1401

            +

            Defined in node_modules/@types/react/index.d.ts:1403


            Optional onLoad#

            onLoad? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onLoad

            -

            Defined in node_modules/@types/react/index.d.ts:1390

            +

            Defined in node_modules/@types/react/index.d.ts:1392


            Optional onLoadCapture#

            onLoadCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onLoadCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1391

            +

            Defined in node_modules/@types/react/index.d.ts:1393


            Optional onLoadStart#

            onLoadStart? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onLoadStart

            -

            Defined in node_modules/@types/react/index.d.ts:1422

            +

            Defined in node_modules/@types/react/index.d.ts:1424


            Optional onLoadStartCapture#

            onLoadStartCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onLoadStartCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1423

            +

            Defined in node_modules/@types/react/index.d.ts:1425


            Optional onLoadedData#

            onLoadedData? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onLoadedData

            -

            Defined in node_modules/@types/react/index.d.ts:1418

            +

            Defined in node_modules/@types/react/index.d.ts:1420


            Optional onLoadedDataCapture#

            onLoadedDataCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onLoadedDataCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1419

            +

            Defined in node_modules/@types/react/index.d.ts:1421


            Optional onLoadedMetadata#

            onLoadedMetadata? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onLoadedMetadata

            -

            Defined in node_modules/@types/react/index.d.ts:1420

            +

            Defined in node_modules/@types/react/index.d.ts:1422


            Optional onLoadedMetadataCapture#

            onLoadedMetadataCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onLoadedMetadataCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1421

            +

            Defined in node_modules/@types/react/index.d.ts:1423


            Optional onLostPointerCapture#

            onLostPointerCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onLostPointerCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1520

            +

            Defined in node_modules/@types/react/index.d.ts:1522


            Optional onLostPointerCaptureCapture#

            onLostPointerCaptureCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onLostPointerCaptureCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1521

            +

            Defined in node_modules/@types/react/index.d.ts:1523


            Optional onMouseDown#

            onMouseDown? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseDown

            -

            Defined in node_modules/@types/react/index.d.ts:1474

            +

            Defined in node_modules/@types/react/index.d.ts:1476


            Optional onMouseDownCapture#

            onMouseDownCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseDownCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1475

            +

            Defined in node_modules/@types/react/index.d.ts:1477


            Optional onMouseEnter#

            onMouseEnter? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseEnter

            -

            Defined in node_modules/@types/react/index.d.ts:1476

            +

            Defined in node_modules/@types/react/index.d.ts:1478


            Optional onMouseLeave#

            onMouseLeave? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseLeave

            -

            Defined in node_modules/@types/react/index.d.ts:1477

            +

            Defined in node_modules/@types/react/index.d.ts:1479


            Optional onMouseMove#

            onMouseMove? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseMove

            -

            Defined in node_modules/@types/react/index.d.ts:1478

            +

            Defined in node_modules/@types/react/index.d.ts:1480


            Optional onMouseMoveCapture#

            onMouseMoveCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseMoveCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1479

            +

            Defined in node_modules/@types/react/index.d.ts:1481


            Optional onMouseOut#

            onMouseOut? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseOut

            -

            Defined in node_modules/@types/react/index.d.ts:1480

            +

            Defined in node_modules/@types/react/index.d.ts:1482


            Optional onMouseOutCapture#

            onMouseOutCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseOutCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1481

            +

            Defined in node_modules/@types/react/index.d.ts:1483


            Optional onMouseOver#

            onMouseOver? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseOver

            -

            Defined in node_modules/@types/react/index.d.ts:1482

            +

            Defined in node_modules/@types/react/index.d.ts:1484


            Optional onMouseOverCapture#

            onMouseOverCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseOverCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1483

            +

            Defined in node_modules/@types/react/index.d.ts:1485


            Optional onMouseUp#

            onMouseUp? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseUp

            -

            Defined in node_modules/@types/react/index.d.ts:1484

            +

            Defined in node_modules/@types/react/index.d.ts:1486


            Optional onMouseUpCapture#

            onMouseUpCapture? : MouseEventHandler‹any›

            Inherited from PageLayoutProps.onMouseUpCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1485

            +

            Defined in node_modules/@types/react/index.d.ts:1487


            Optional onPaste#

            onPaste? : ClipboardEventHandler‹any›

            Inherited from PageLayoutProps.onPaste

            -

            Defined in node_modules/@types/react/index.d.ts:1358

            +

            Defined in node_modules/@types/react/index.d.ts:1360


            Optional onPasteCapture#

            onPasteCapture? : ClipboardEventHandler‹any›

            Inherited from PageLayoutProps.onPasteCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1359

            +

            Defined in node_modules/@types/react/index.d.ts:1361


            Optional onPause#

            onPause? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onPause

            -

            Defined in node_modules/@types/react/index.d.ts:1424

            +

            Defined in node_modules/@types/react/index.d.ts:1426


            Optional onPauseCapture#

            onPauseCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onPauseCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1425

            +

            Defined in node_modules/@types/react/index.d.ts:1427


            Optional onPlay#

            onPlay? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onPlay

            -

            Defined in node_modules/@types/react/index.d.ts:1426

            +

            Defined in node_modules/@types/react/index.d.ts:1428


            Optional onPlayCapture#

            onPlayCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onPlayCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1427

            +

            Defined in node_modules/@types/react/index.d.ts:1429


            Optional onPlaying#

            onPlaying? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onPlaying

            -

            Defined in node_modules/@types/react/index.d.ts:1428

            +

            Defined in node_modules/@types/react/index.d.ts:1430


            Optional onPlayingCapture#

            onPlayingCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onPlayingCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1429

            +

            Defined in node_modules/@types/react/index.d.ts:1431


            Optional onPointerCancel#

            onPointerCancel? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerCancel

            -

            Defined in node_modules/@types/react/index.d.ts:1508

            +

            Defined in node_modules/@types/react/index.d.ts:1510


            Optional onPointerCancelCapture#

            onPointerCancelCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerCancelCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1509

            +

            Defined in node_modules/@types/react/index.d.ts:1511


            Optional onPointerDown#

            onPointerDown? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerDown

            -

            Defined in node_modules/@types/react/index.d.ts:1502

            +

            Defined in node_modules/@types/react/index.d.ts:1504


            Optional onPointerDownCapture#

            onPointerDownCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerDownCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1503

            +

            Defined in node_modules/@types/react/index.d.ts:1505


            Optional onPointerEnter#

            onPointerEnter? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerEnter

            -

            Defined in node_modules/@types/react/index.d.ts:1510

            +

            Defined in node_modules/@types/react/index.d.ts:1512


            Optional onPointerEnterCapture#

            onPointerEnterCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerEnterCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1511

            +

            Defined in node_modules/@types/react/index.d.ts:1513


            Optional onPointerLeave#

            onPointerLeave? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerLeave

            -

            Defined in node_modules/@types/react/index.d.ts:1512

            +

            Defined in node_modules/@types/react/index.d.ts:1514


            Optional onPointerLeaveCapture#

            onPointerLeaveCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerLeaveCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1513

            +

            Defined in node_modules/@types/react/index.d.ts:1515


            Optional onPointerMove#

            onPointerMove? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerMove

            -

            Defined in node_modules/@types/react/index.d.ts:1504

            +

            Defined in node_modules/@types/react/index.d.ts:1506


            Optional onPointerMoveCapture#

            onPointerMoveCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerMoveCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1505

            +

            Defined in node_modules/@types/react/index.d.ts:1507


            Optional onPointerOut#

            onPointerOut? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerOut

            -

            Defined in node_modules/@types/react/index.d.ts:1516

            +

            Defined in node_modules/@types/react/index.d.ts:1518


            Optional onPointerOutCapture#

            onPointerOutCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerOutCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1517

            +

            Defined in node_modules/@types/react/index.d.ts:1519


            Optional onPointerOver#

            onPointerOver? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerOver

            -

            Defined in node_modules/@types/react/index.d.ts:1514

            +

            Defined in node_modules/@types/react/index.d.ts:1516


            Optional onPointerOverCapture#

            onPointerOverCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerOverCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1515

            +

            Defined in node_modules/@types/react/index.d.ts:1517


            Optional onPointerUp#

            onPointerUp? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerUp

            -

            Defined in node_modules/@types/react/index.d.ts:1506

            +

            Defined in node_modules/@types/react/index.d.ts:1508


            Optional onPointerUpCapture#

            onPointerUpCapture? : PointerEventHandler‹any›

            Inherited from PageLayoutProps.onPointerUpCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1507

            +

            Defined in node_modules/@types/react/index.d.ts:1509


            Optional onProgress#

            onProgress? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onProgress

            -

            Defined in node_modules/@types/react/index.d.ts:1430

            +

            Defined in node_modules/@types/react/index.d.ts:1432


            Optional onProgressCapture#

            onProgressCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onProgressCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1431

            +

            Defined in node_modules/@types/react/index.d.ts:1433


            Optional onRateChange#

            onRateChange? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onRateChange

            -

            Defined in node_modules/@types/react/index.d.ts:1432

            +

            Defined in node_modules/@types/react/index.d.ts:1434


            Optional onRateChangeCapture#

            onRateChangeCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onRateChangeCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1433

            +

            Defined in node_modules/@types/react/index.d.ts:1435


            Optional onReset#

            onReset? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onReset

            -

            Defined in node_modules/@types/react/index.d.ts:1382

            +

            Defined in node_modules/@types/react/index.d.ts:1384


            Optional onResetCapture#

            onResetCapture? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onResetCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1383

            +

            Defined in node_modules/@types/react/index.d.ts:1385


            Optional onScroll#

            onScroll? : UIEventHandler‹any›

            Inherited from PageLayoutProps.onScroll

            -

            Defined in node_modules/@types/react/index.d.ts:1524

            +

            Defined in node_modules/@types/react/index.d.ts:1526


            Optional onScrollCapture#

            onScrollCapture? : UIEventHandler‹any›

            Inherited from PageLayoutProps.onScrollCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1525

            +

            Defined in node_modules/@types/react/index.d.ts:1527


            Optional onSeeked#

            onSeeked? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onSeeked

            -

            Defined in node_modules/@types/react/index.d.ts:1434

            +

            Defined in node_modules/@types/react/index.d.ts:1436


            Optional onSeekedCapture#

            onSeekedCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onSeekedCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1435

            +

            Defined in node_modules/@types/react/index.d.ts:1437


            Optional onSeeking#

            onSeeking? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onSeeking

            -

            Defined in node_modules/@types/react/index.d.ts:1436

            +

            Defined in node_modules/@types/react/index.d.ts:1438


            Optional onSeekingCapture#

            onSeekingCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onSeekingCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1437

            +

            Defined in node_modules/@types/react/index.d.ts:1439


            Optional onSelect#

            onSelect? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onSelect

            -

            Defined in node_modules/@types/react/index.d.ts:1488

            +

            Defined in node_modules/@types/react/index.d.ts:1490


            Optional onSelectCapture#

            onSelectCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onSelectCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1489

            +

            Defined in node_modules/@types/react/index.d.ts:1491


            Optional onStalled#

            onStalled? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onStalled

            -

            Defined in node_modules/@types/react/index.d.ts:1438

            +

            Defined in node_modules/@types/react/index.d.ts:1440


            Optional onStalledCapture#

            onStalledCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onStalledCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1439

            +

            Defined in node_modules/@types/react/index.d.ts:1441


            Optional onSubmit#

            onSubmit? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onSubmit

            -

            Defined in node_modules/@types/react/index.d.ts:1384

            +

            Defined in node_modules/@types/react/index.d.ts:1386


            Optional onSubmitCapture#

            onSubmitCapture? : FormEventHandler‹any›

            Inherited from PageLayoutProps.onSubmitCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1385

            +

            Defined in node_modules/@types/react/index.d.ts:1387


            Optional onSuspend#

            onSuspend? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onSuspend

            -

            Defined in node_modules/@types/react/index.d.ts:1440

            +

            Defined in node_modules/@types/react/index.d.ts:1442


            Optional onSuspendCapture#

            onSuspendCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onSuspendCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1441

            +

            Defined in node_modules/@types/react/index.d.ts:1443


            Optional onTimeUpdate#

            onTimeUpdate? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onTimeUpdate

            -

            Defined in node_modules/@types/react/index.d.ts:1442

            +

            Defined in node_modules/@types/react/index.d.ts:1444


            Optional onTimeUpdateCapture#

            onTimeUpdateCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onTimeUpdateCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1443

            +

            Defined in node_modules/@types/react/index.d.ts:1445


            Optional onTouchCancel#

            onTouchCancel? : TouchEventHandler‹any›

            Inherited from PageLayoutProps.onTouchCancel

            -

            Defined in node_modules/@types/react/index.d.ts:1492

            +

            Defined in node_modules/@types/react/index.d.ts:1494


            Optional onTouchCancelCapture#

            onTouchCancelCapture? : TouchEventHandler‹any›

            Inherited from PageLayoutProps.onTouchCancelCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1493

            +

            Defined in node_modules/@types/react/index.d.ts:1495


            Optional onTouchEnd#

            onTouchEnd? : TouchEventHandler‹any›

            Inherited from PageLayoutProps.onTouchEnd

            -

            Defined in node_modules/@types/react/index.d.ts:1494

            +

            Defined in node_modules/@types/react/index.d.ts:1496


            Optional onTouchEndCapture#

            onTouchEndCapture? : TouchEventHandler‹any›

            Inherited from PageLayoutProps.onTouchEndCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1495

            +

            Defined in node_modules/@types/react/index.d.ts:1497


            Optional onTouchMove#

            onTouchMove? : TouchEventHandler‹any›

            Inherited from PageLayoutProps.onTouchMove

            -

            Defined in node_modules/@types/react/index.d.ts:1496

            +

            Defined in node_modules/@types/react/index.d.ts:1498


            Optional onTouchMoveCapture#

            onTouchMoveCapture? : TouchEventHandler‹any›

            Inherited from PageLayoutProps.onTouchMoveCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1497

            +

            Defined in node_modules/@types/react/index.d.ts:1499


            Optional onTouchStart#

            onTouchStart? : TouchEventHandler‹any›

            Inherited from PageLayoutProps.onTouchStart

            -

            Defined in node_modules/@types/react/index.d.ts:1498

            +

            Defined in node_modules/@types/react/index.d.ts:1500


            Optional onTouchStartCapture#

            onTouchStartCapture? : TouchEventHandler‹any›

            Inherited from PageLayoutProps.onTouchStartCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1499

            +

            Defined in node_modules/@types/react/index.d.ts:1501


            Optional onTransitionEnd#

            onTransitionEnd? : TransitionEventHandler‹any›

            Inherited from PageLayoutProps.onTransitionEnd

            -

            Defined in node_modules/@types/react/index.d.ts:1540

            +

            Defined in node_modules/@types/react/index.d.ts:1542


            Optional onTransitionEndCapture#

            onTransitionEndCapture? : TransitionEventHandler‹any›

            Inherited from PageLayoutProps.onTransitionEndCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1541

            +

            Defined in node_modules/@types/react/index.d.ts:1543


            Optional onVolumeChange#

            onVolumeChange? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onVolumeChange

            -

            Defined in node_modules/@types/react/index.d.ts:1444

            +

            Defined in node_modules/@types/react/index.d.ts:1446


            Optional onVolumeChangeCapture#

            onVolumeChangeCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onVolumeChangeCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1445

            +

            Defined in node_modules/@types/react/index.d.ts:1447


            Optional onWaiting#

            onWaiting? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onWaiting

            -

            Defined in node_modules/@types/react/index.d.ts:1446

            +

            Defined in node_modules/@types/react/index.d.ts:1448


            Optional onWaitingCapture#

            onWaitingCapture? : ReactEventHandler‹any›

            Inherited from PageLayoutProps.onWaitingCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1447

            +

            Defined in node_modules/@types/react/index.d.ts:1449


            Optional onWheel#

            onWheel? : WheelEventHandler‹any›

            Inherited from PageLayoutProps.onWheel

            -

            Defined in node_modules/@types/react/index.d.ts:1528

            +

            Defined in node_modules/@types/react/index.d.ts:1530


            Optional onWheelCapture#

            onWheelCapture? : WheelEventHandler‹any›

            Inherited from PageLayoutProps.onWheelCapture

            -

            Defined in node_modules/@types/react/index.d.ts:1529

            +

            Defined in node_modules/@types/react/index.d.ts:1531


            Optional open#

            open? : boolean

            Inherited from LineProgressProps.open

            -

            Defined in node_modules/@types/react/index.d.ts:1882

            +

            Defined in node_modules/@types/react/index.d.ts:1884


            Optional optimum#

            optimum? : number

            Inherited from LineProgressProps.optimum

            -

            Defined in node_modules/@types/react/index.d.ts:1883

            +

            Defined in node_modules/@types/react/index.d.ts:1885


            Optional pattern#

            pattern? : string

            Inherited from LineProgressProps.pattern

            -

            Defined in node_modules/@types/react/index.d.ts:1884

            +

            Defined in node_modules/@types/react/index.d.ts:1886


            Optional placeholder#

            placeholder? : string

            Inherited from LineProgressProps.placeholder

            Overrides ButtonProps.placeholder

            -

            Defined in node_modules/@types/react/index.d.ts:1885

            +

            Defined in node_modules/@types/react/index.d.ts:1887


            Optional playsInline#

            playsInline? : boolean

            Inherited from LineProgressProps.playsInline

            -

            Defined in node_modules/@types/react/index.d.ts:1886

            +

            Defined in node_modules/@types/react/index.d.ts:1888


            Optional poster#

            poster? : string

            Inherited from LineProgressProps.poster

            -

            Defined in node_modules/@types/react/index.d.ts:1887

            +

            Defined in node_modules/@types/react/index.d.ts:1889


            Optional prefix#

            prefix? : string

            Inherited from ButtonProps.prefix

            -

            Defined in node_modules/@types/react/index.d.ts:1778

            +

            Defined in node_modules/@types/react/index.d.ts:1780


            Optional preload#

            preload? : string

            Inherited from LineProgressProps.preload

            -

            Defined in node_modules/@types/react/index.d.ts:1888

            +

            Defined in node_modules/@types/react/index.d.ts:1890


            Optional property#

            property? : string

            Inherited from ButtonProps.property

            -

            Defined in node_modules/@types/react/index.d.ts:1779

            +

            Defined in node_modules/@types/react/index.d.ts:1781


            Optional radioGroup#

            radioGroup? : string

            Inherited from ButtonProps.radioGroup

            -

            Defined in node_modules/@types/react/index.d.ts:1769

            +

            Defined in node_modules/@types/react/index.d.ts:1771


            Optional readOnly#

            readOnly? : boolean

            Inherited from LineProgressProps.readOnly

            -

            Defined in node_modules/@types/react/index.d.ts:1889

            +

            Defined in node_modules/@types/react/index.d.ts:1891


            Optional ref#

            ref? : LegacyRef‹any›

            Inherited from LineProgressProps.ref

            -

            Defined in node_modules/@types/react/index.d.ts:145

            +

            Defined in node_modules/@types/react/index.d.ts:143


            Optional rel#

            rel? : string

            Inherited from LineProgressProps.rel

            -

            Defined in node_modules/@types/react/index.d.ts:1890

            +

            Defined in node_modules/@types/react/index.d.ts:1892


            Optional required#

            required? : boolean

            Inherited from LineProgressProps.required

            -

            Defined in node_modules/@types/react/index.d.ts:1891

            +

            Defined in node_modules/@types/react/index.d.ts:1893


            Optional resource#

            resource? : string

            Inherited from ButtonProps.resource

            -

            Defined in node_modules/@types/react/index.d.ts:1780

            +

            Defined in node_modules/@types/react/index.d.ts:1782


            Optional results#

            results? : number

            Inherited from ButtonProps.results

            -

            Defined in node_modules/@types/react/index.d.ts:1794

            +

            Defined in node_modules/@types/react/index.d.ts:1796


            Optional reversed#

            reversed? : boolean

            Inherited from LineProgressProps.reversed

            -

            Defined in node_modules/@types/react/index.d.ts:1892

            +

            Defined in node_modules/@types/react/index.d.ts:1894


            Optional role#

            role? : string

            Inherited from ButtonProps.role

            -

            Defined in node_modules/@types/react/index.d.ts:1772

            +

            Defined in node_modules/@types/react/index.d.ts:1774


            Optional rowSpan#

            rowSpan? : number

            Inherited from LineProgressProps.rowSpan

            -

            Defined in node_modules/@types/react/index.d.ts:1894

            +

            Defined in node_modules/@types/react/index.d.ts:1896


            Optional rows#

            rows? : number

            Inherited from LineProgressProps.rows

            -

            Defined in node_modules/@types/react/index.d.ts:1893

            +

            Defined in node_modules/@types/react/index.d.ts:1895


            Optional sandbox#

            sandbox? : string

            Inherited from LineProgressProps.sandbox

            -

            Defined in node_modules/@types/react/index.d.ts:1895

            +

            Defined in node_modules/@types/react/index.d.ts:1897


            Optional scope#

            scope? : string

            Inherited from LineProgressProps.scope

            -

            Defined in node_modules/@types/react/index.d.ts:1896

            +

            Defined in node_modules/@types/react/index.d.ts:1898


            Optional scoped#

            scoped? : boolean

            Inherited from LineProgressProps.scoped

            -

            Defined in node_modules/@types/react/index.d.ts:1897

            +

            Defined in node_modules/@types/react/index.d.ts:1899


            Optional scrolling#

            scrolling? : string

            Inherited from LineProgressProps.scrolling

            -

            Defined in node_modules/@types/react/index.d.ts:1898

            +

            Defined in node_modules/@types/react/index.d.ts:1900


            Optional seamless#

            seamless? : boolean

            Inherited from LineProgressProps.seamless

            -

            Defined in node_modules/@types/react/index.d.ts:1899

            +

            Defined in node_modules/@types/react/index.d.ts:1901


            Optional security#

            security? : string

            Inherited from ButtonProps.security

            -

            Defined in node_modules/@types/react/index.d.ts:1795

            +

            Defined in node_modules/@types/react/index.d.ts:1797


            Optional selected#

            selected? : boolean

            Inherited from LineProgressProps.selected

            -

            Defined in node_modules/@types/react/index.d.ts:1900

            +

            Defined in node_modules/@types/react/index.d.ts:1902


            Optional shape#

            shape? : string

            Inherited from LineProgressProps.shape

            -

            Defined in node_modules/@types/react/index.d.ts:1901

            +

            Defined in node_modules/@types/react/index.d.ts:1903


            Optional size#

            size? : number

            Inherited from LineProgressProps.size

            -

            Defined in node_modules/@types/react/index.d.ts:1902

            +

            Defined in node_modules/@types/react/index.d.ts:1904


            Optional sizes#

            sizes? : string

            Inherited from LineProgressProps.sizes

            -

            Defined in node_modules/@types/react/index.d.ts:1903

            +

            Defined in node_modules/@types/react/index.d.ts:1905


            Optional slot#

            slot? : string

            Inherited from ButtonProps.slot

            -

            Defined in node_modules/@types/react/index.d.ts:1761

            +

            Defined in node_modules/@types/react/index.d.ts:1763


            Optional span#

            span? : number

            Inherited from LineProgressProps.span

            -

            Defined in node_modules/@types/react/index.d.ts:1904

            +

            Defined in node_modules/@types/react/index.d.ts:1906


            Optional spellCheck#

            spellCheck? : Booleanish

            Inherited from ButtonProps.spellCheck

            -

            Defined in node_modules/@types/react/index.d.ts:1762

            +

            Defined in node_modules/@types/react/index.d.ts:1764


            Optional src#

            src? : string

            Inherited from LineProgressProps.src

            -

            Defined in node_modules/@types/react/index.d.ts:1905

            +

            Defined in node_modules/@types/react/index.d.ts:1907


            Optional srcDoc#

            srcDoc? : string

            Inherited from LineProgressProps.srcDoc

            -

            Defined in node_modules/@types/react/index.d.ts:1906

            +

            Defined in node_modules/@types/react/index.d.ts:1908


            Optional srcLang#

            srcLang? : string

            Inherited from LineProgressProps.srcLang

            -

            Defined in node_modules/@types/react/index.d.ts:1907

            +

            Defined in node_modules/@types/react/index.d.ts:1909


            Optional srcSet#

            srcSet? : string

            Inherited from LineProgressProps.srcSet

            -

            Defined in node_modules/@types/react/index.d.ts:1908

            +

            Defined in node_modules/@types/react/index.d.ts:1910


            Optional start#

            start? : number

            Inherited from LineProgressProps.start

            -

            Defined in node_modules/@types/react/index.d.ts:1909

            +

            Defined in node_modules/@types/react/index.d.ts:1911


            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

            Inherited from ButtonProps.style

            -

            Defined in node_modules/@types/react/index.d.ts:1763

            +

            Defined in node_modules/@types/react/index.d.ts:1765


            Optional summary#

            summary? : string

            Inherited from LineProgressProps.summary

            -

            Defined in node_modules/@types/react/index.d.ts:1911

            +

            Defined in node_modules/@types/react/index.d.ts:1913


            Optional suppressContentEditableWarning#

            suppressContentEditableWarning? : boolean

            Inherited from ButtonProps.suppressContentEditableWarning

            -

            Defined in node_modules/@types/react/index.d.ts:1747

            +

            Defined in node_modules/@types/react/index.d.ts:1749


            Optional suppressHydrationWarning#

            suppressHydrationWarning? : boolean

            Inherited from ButtonProps.suppressHydrationWarning

            -

            Defined in node_modules/@types/react/index.d.ts:1748

            +

            Defined in node_modules/@types/react/index.d.ts:1750


            Optional tabIndex#

            tabIndex? : number

            Inherited from ButtonProps.tabIndex

            -

            Defined in node_modules/@types/react/index.d.ts:1764

            +

            Defined in node_modules/@types/react/index.d.ts:1766


            Optional target#

            target? : string

            Inherited from LineProgressProps.target

            -

            Defined in node_modules/@types/react/index.d.ts:1912

            +

            Defined in node_modules/@types/react/index.d.ts:1914


            Optional title#

            title? : string

            Inherited from ButtonProps.title

            -

            Defined in node_modules/@types/react/index.d.ts:1765

            +

            Defined in node_modules/@types/react/index.d.ts:1767


            Optional translate#

            translate? : "yes" | "no"

            Inherited from ButtonProps.translate

            -

            Defined in node_modules/@types/react/index.d.ts:1766

            +

            Defined in node_modules/@types/react/index.d.ts:1768


            Optional type#

            type? : string

            Inherited from LineProgressProps.type

            -

            Defined in node_modules/@types/react/index.d.ts:1913

            +

            Defined in node_modules/@types/react/index.d.ts:1915


            Optional typeof#

            typeof? : string

            Inherited from ButtonProps.typeof

            -

            Defined in node_modules/@types/react/index.d.ts:1781

            +

            Defined in node_modules/@types/react/index.d.ts:1783


            Optional unselectable#

            unselectable? : "on" | "off"

            Inherited from ButtonProps.unselectable

            -

            Defined in node_modules/@types/react/index.d.ts:1796

            +

            Defined in node_modules/@types/react/index.d.ts:1798


            Optional useMap#

            useMap? : string

            Inherited from LineProgressProps.useMap

            -

            Defined in node_modules/@types/react/index.d.ts:1914

            +

            Defined in node_modules/@types/react/index.d.ts:1916


            Optional value#

            -

            value? : string | string[] | number

            +

            value? : string | ReadonlyArray‹string› | number

            Inherited from MenuItemProps.value

            -

            Defined in node_modules/@types/react/index.d.ts:1915

            +

            Defined in node_modules/@types/react/index.d.ts:1917


            Optional vocab#

            vocab? : string

            Inherited from ButtonProps.vocab

            -

            Defined in node_modules/@types/react/index.d.ts:1782

            +

            Defined in node_modules/@types/react/index.d.ts:1784


            Optional width#

            width? : number | string

            Inherited from LineProgressProps.width

            -

            Defined in node_modules/@types/react/index.d.ts:1916

            +

            Defined in node_modules/@types/react/index.d.ts:1918


            Optional wmode#

            wmode? : string

            Inherited from LineProgressProps.wmode

            -

            Defined in node_modules/@types/react/index.d.ts:1917

            +

            Defined in node_modules/@types/react/index.d.ts:1919


            Optional wrap#

            wrap? : string

            Inherited from LineProgressProps.wrap

            -

            Defined in node_modules/@types/react/index.d.ts:1918

            +

            Defined in node_modules/@types/react/index.d.ts:1920

            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 794b92e374..7554a6bdb4 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • @@ -911,19 +911,19 @@

            Properties#

            Optional children#

            children? : ReactNode

            -

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

            +

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


            Optional className#

            className? : IClassName

            -

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

            +

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


            Optional contentClass#

            contentClass? : IClassName

            -

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

            +

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


            Optional tabs#

            tabs? : TabLayoutRoute[]

            -

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

            +

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

            diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html index c44620af64..34b7a6e491 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • @@ -927,27 +927,27 @@

            Properties#

            component#

            component: React.ComponentType‹any›

            -

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

            +

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


            Optional default#

            default? : boolean

            -

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

            +

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


            Optional exact#

            exact? : boolean

            -

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

            +

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


            routePath#

            routePath: string

            -

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

            +

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


            title#

            title: React.ReactNode

            -

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

            +

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


            Optional url#

            url? : string

            -

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

            +

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

            diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html index 44389b9f1d..c3dd9a9186 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • @@ -895,6 +895,13 @@ Optional dangerouslySetInnerHTML + + +
          • + + Optional id + +
          • @@ -2029,6 +2036,13 @@ Optional renderBoolean +
          • + +
          • + + Optional showWithColumn + +
          • @@ -2099,6 +2113,7 @@
          • children
          • className
          • dangerouslySetInnerHTML
          • +
          • id
          • isChecked
          • onAbort
          • onAbortCapture
          • @@ -2261,6 +2276,7 @@
          • onWheel
          • onWheelCapture
          • renderBoolean
          • +
          • showWithColumn
          • sortBy
          • title
          @@ -2271,853 +2287,861 @@

          Properties#

          Optional _nowrap#

          _nowrap? : boolean

          -

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

          +

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


          Optional _sorting#

          _sorting? : Partial‹TableSortParams

          -

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

          +

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


          Optional checkbox#

          checkbox? : boolean

          -

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

          +

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


          Optional children#

          children? : ReactNode

          Inherited from PageLayoutProps.children

          -

          Defined in node_modules/@types/react/index.d.ts:1348

          +

          Defined in node_modules/@types/react/index.d.ts:1350


          Optional className#

          className? : string

          -

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

          +

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


          Optional dangerouslySetInnerHTML#

          dangerouslySetInnerHTML? : object

          Inherited from PageLayoutProps.dangerouslySetInnerHTML

          -

          Defined in node_modules/@types/react/index.d.ts:1349

          +

          Defined in node_modules/@types/react/index.d.ts:1351

          Type declaration:

          • __html: string

          +

          Optional id#

          +

          id? : string

          +

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

          +

          Optional isChecked#

          isChecked? : boolean

          -

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

          +

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


          Optional onAbort#

          onAbort? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAbort

          -

          Defined in node_modules/@types/react/index.d.ts:1404

          +

          Defined in node_modules/@types/react/index.d.ts:1406


          Optional onAbortCapture#

          onAbortCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAbortCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1405

          +

          Defined in node_modules/@types/react/index.d.ts:1407


          Optional onAnimationEnd#

          onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1534

          +

          Defined in node_modules/@types/react/index.d.ts:1536


          Optional onAnimationEndCapture#

          onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1535

          +

          Defined in node_modules/@types/react/index.d.ts:1537


          Optional onAnimationIteration#

          onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationIteration

          -

          Defined in node_modules/@types/react/index.d.ts:1536

          +

          Defined in node_modules/@types/react/index.d.ts:1538


          Optional onAnimationIterationCapture#

          onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationIterationCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1537

          +

          Defined in node_modules/@types/react/index.d.ts:1539


          Optional onAnimationStart#

          onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationStart

          -

          Defined in node_modules/@types/react/index.d.ts:1532

          +

          Defined in node_modules/@types/react/index.d.ts:1534


          Optional onAnimationStartCapture#

          onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1533

          +

          Defined in node_modules/@types/react/index.d.ts:1535


          Optional onAuxClick#

          onAuxClick? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAuxClick

          -

          Defined in node_modules/@types/react/index.d.ts:1450

          +

          Defined in node_modules/@types/react/index.d.ts:1452


          Optional onAuxClickCapture#

          onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAuxClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1451

          +

          Defined in node_modules/@types/react/index.d.ts:1453


          Optional onBeforeInput#

          onBeforeInput? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onBeforeInput

          -

          Defined in node_modules/@types/react/index.d.ts:1378

          +

          Defined in node_modules/@types/react/index.d.ts:1380


          Optional onBeforeInputCapture#

          onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onBeforeInputCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1379

          +

          Defined in node_modules/@types/react/index.d.ts:1381


          Optional onBlur#

          onBlur? : FocusEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onBlur

          -

          Defined in node_modules/@types/react/index.d.ts:1372

          +

          Defined in node_modules/@types/react/index.d.ts:1374


          Optional onBlurCapture#

          onBlurCapture? : FocusEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onBlurCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1373

          +

          Defined in node_modules/@types/react/index.d.ts:1375


          Optional onCanPlay#

          onCanPlay? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCanPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1406

          +

          Defined in node_modules/@types/react/index.d.ts:1408


          Optional onCanPlayCapture#

          onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCanPlayCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1407

          +

          Defined in node_modules/@types/react/index.d.ts:1409


          Optional onCanPlayThrough#

          onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCanPlayThrough

          -

          Defined in node_modules/@types/react/index.d.ts:1408

          +

          Defined in node_modules/@types/react/index.d.ts:1410


          Optional onCanPlayThroughCapture#

          onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCanPlayThroughCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1409

          +

          Defined in node_modules/@types/react/index.d.ts:1411


          Optional onChange#

          onChange? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onChange

          -

          Defined in node_modules/@types/react/index.d.ts:1376

          +

          Defined in node_modules/@types/react/index.d.ts:1378


          Optional onChangeCapture#

          onChangeCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1377

          +

          Defined in node_modules/@types/react/index.d.ts:1379


          Optional onClick#

          onClick? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onClick

          -

          Defined in node_modules/@types/react/index.d.ts:1452

          +

          Defined in node_modules/@types/react/index.d.ts:1454


          Optional onClickCapture#

          onClickCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1453

          +

          Defined in node_modules/@types/react/index.d.ts:1455


          Optional onCompositionEnd#

          onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1362

          +

          Defined in node_modules/@types/react/index.d.ts:1364


          Optional onCompositionEndCapture#

          onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1363

          +

          Defined in node_modules/@types/react/index.d.ts:1365


          Optional onCompositionStart#

          onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionStart

          -

          Defined in node_modules/@types/react/index.d.ts:1364

          +

          Defined in node_modules/@types/react/index.d.ts:1366


          Optional onCompositionStartCapture#

          onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1365

          +

          Defined in node_modules/@types/react/index.d.ts:1367


          Optional onCompositionUpdate#

          onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionUpdate

          -

          Defined in node_modules/@types/react/index.d.ts:1366

          +

          Defined in node_modules/@types/react/index.d.ts:1368


          Optional onCompositionUpdateCapture#

          onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionUpdateCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1367

          +

          Defined in node_modules/@types/react/index.d.ts:1369


          Optional onContextMenu#

          onContextMenu? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onContextMenu

          -

          Defined in node_modules/@types/react/index.d.ts:1454

          +

          Defined in node_modules/@types/react/index.d.ts:1456


          Optional onContextMenuCapture#

          onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onContextMenuCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1455

          +

          Defined in node_modules/@types/react/index.d.ts:1457


          Optional onCopy#

          onCopy? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCopy

          -

          Defined in node_modules/@types/react/index.d.ts:1354

          +

          Defined in node_modules/@types/react/index.d.ts:1356


          Optional onCopyCapture#

          onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCopyCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1355

          +

          Defined in node_modules/@types/react/index.d.ts:1357


          Optional onCut#

          onCut? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCut

          -

          Defined in node_modules/@types/react/index.d.ts:1356

          +

          Defined in node_modules/@types/react/index.d.ts:1358


          Optional onCutCapture#

          onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1357

          +

          Defined in node_modules/@types/react/index.d.ts:1359


          Optional onDoubleClick#

          onDoubleClick? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDoubleClick

          -

          Defined in node_modules/@types/react/index.d.ts:1456

          +

          Defined in node_modules/@types/react/index.d.ts:1458


          Optional onDoubleClickCapture#

          onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDoubleClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1457

          +

          Defined in node_modules/@types/react/index.d.ts:1459


          Optional onDrag#

          onDrag? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDrag

          -

          Defined in node_modules/@types/react/index.d.ts:1458

          +

          Defined in node_modules/@types/react/index.d.ts:1460


          Optional onDragCapture#

          onDragCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1459

          +

          Defined in node_modules/@types/react/index.d.ts:1461


          Optional onDragEnd#

          onDragEnd? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1460

          +

          Defined in node_modules/@types/react/index.d.ts:1462


          Optional onDragEndCapture#

          onDragEndCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1461

          +

          Defined in node_modules/@types/react/index.d.ts:1463


          Optional onDragEnter#

          onDragEnter? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1462

          +

          Defined in node_modules/@types/react/index.d.ts:1464


          Optional onDragEnterCapture#

          onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragEnterCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1463

          +

          Defined in node_modules/@types/react/index.d.ts:1465


          Optional onDragExit#

          onDragExit? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragExit

          -

          Defined in node_modules/@types/react/index.d.ts:1464

          +

          Defined in node_modules/@types/react/index.d.ts:1466


          Optional onDragExitCapture#

          onDragExitCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragExitCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1465

          +

          Defined in node_modules/@types/react/index.d.ts:1467


          Optional onDragLeave#

          onDragLeave? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1466

          +

          Defined in node_modules/@types/react/index.d.ts:1468


          Optional onDragLeaveCapture#

          onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragLeaveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1467

          +

          Defined in node_modules/@types/react/index.d.ts:1469


          Optional onDragOver#

          onDragOver? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragOver

          -

          Defined in node_modules/@types/react/index.d.ts:1468

          +

          Defined in node_modules/@types/react/index.d.ts:1470


          Optional onDragOverCapture#

          onDragOverCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1469

          +

          Defined in node_modules/@types/react/index.d.ts:1471


          Optional onDragStart#

          onDragStart? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragStart

          -

          Defined in node_modules/@types/react/index.d.ts:1470

          +

          Defined in node_modules/@types/react/index.d.ts:1472


          Optional onDragStartCapture#

          onDragStartCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1471

          +

          Defined in node_modules/@types/react/index.d.ts:1473


          Optional onDrop#

          onDrop? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDrop

          -

          Defined in node_modules/@types/react/index.d.ts:1472

          +

          Defined in node_modules/@types/react/index.d.ts:1474


          Optional onDropCapture#

          onDropCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDropCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1473

          +

          Defined in node_modules/@types/react/index.d.ts:1475


          Optional onDurationChange#

          onDurationChange? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDurationChange

          -

          Defined in node_modules/@types/react/index.d.ts:1410

          +

          Defined in node_modules/@types/react/index.d.ts:1412


          Optional onDurationChangeCapture#

          onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDurationChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1411

          +

          Defined in node_modules/@types/react/index.d.ts:1413


          Optional onEmptied#

          onEmptied? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEmptied

          -

          Defined in node_modules/@types/react/index.d.ts:1412

          +

          Defined in node_modules/@types/react/index.d.ts:1414


          Optional onEmptiedCapture#

          onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEmptiedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1413

          +

          Defined in node_modules/@types/react/index.d.ts:1415


          Optional onEncrypted#

          onEncrypted? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEncrypted

          -

          Defined in node_modules/@types/react/index.d.ts:1414

          +

          Defined in node_modules/@types/react/index.d.ts:1416


          Optional onEncryptedCapture#

          onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEncryptedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1415

          +

          Defined in node_modules/@types/react/index.d.ts:1417


          Optional onEnded#

          onEnded? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEnded

          -

          Defined in node_modules/@types/react/index.d.ts:1416

          +

          Defined in node_modules/@types/react/index.d.ts:1418


          Optional onEndedCapture#

          onEndedCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEndedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1417

          +

          Defined in node_modules/@types/react/index.d.ts:1419


          Optional onError#

          onError? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onError

          -

          Defined in node_modules/@types/react/index.d.ts:1392

          +

          Defined in node_modules/@types/react/index.d.ts:1394


          Optional onErrorCapture#

          onErrorCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onErrorCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1393

          +

          Defined in node_modules/@types/react/index.d.ts:1395


          Optional onFocus#

          onFocus? : FocusEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onFocus

          -

          Defined in node_modules/@types/react/index.d.ts:1370

          +

          Defined in node_modules/@types/react/index.d.ts:1372


          Optional onFocusCapture#

          onFocusCapture? : FocusEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onFocusCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1371

          +

          Defined in node_modules/@types/react/index.d.ts:1373


          Optional onGotPointerCapture#

          onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onGotPointerCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1518

          +

          Defined in node_modules/@types/react/index.d.ts:1520


          Optional onGotPointerCaptureCapture#

          onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onGotPointerCaptureCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1519

          +

          Defined in node_modules/@types/react/index.d.ts:1521


          Optional onInput#

          onInput? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onInput

          -

          Defined in node_modules/@types/react/index.d.ts:1380

          +

          Defined in node_modules/@types/react/index.d.ts:1382


          Optional onInputCapture#

          onInputCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onInputCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1381

          +

          Defined in node_modules/@types/react/index.d.ts:1383


          Optional onInvalid#

          onInvalid? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onInvalid

          -

          Defined in node_modules/@types/react/index.d.ts:1386

          +

          Defined in node_modules/@types/react/index.d.ts:1388


          Optional onInvalidCapture#

          onInvalidCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onInvalidCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1387

          +

          Defined in node_modules/@types/react/index.d.ts:1389


          Optional onKeyDown#

          onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyDown

          -

          Defined in node_modules/@types/react/index.d.ts:1396

          +

          Defined in node_modules/@types/react/index.d.ts:1398


          Optional onKeyDownCapture#

          onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1397

          +

          Defined in node_modules/@types/react/index.d.ts:1399


          Optional onKeyPress#

          onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyPress

          -

          Defined in node_modules/@types/react/index.d.ts:1398

          +

          Defined in node_modules/@types/react/index.d.ts:1400


          Optional onKeyPressCapture#

          onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyPressCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1399

          +

          Defined in node_modules/@types/react/index.d.ts:1401


          Optional onKeyUp#

          onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyUp

          -

          Defined in node_modules/@types/react/index.d.ts:1400

          +

          Defined in node_modules/@types/react/index.d.ts:1402


          Optional onKeyUpCapture#

          onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1401

          +

          Defined in node_modules/@types/react/index.d.ts:1403


          Optional onLoad#

          onLoad? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoad

          -

          Defined in node_modules/@types/react/index.d.ts:1390

          +

          Defined in node_modules/@types/react/index.d.ts:1392


          Optional onLoadCapture#

          onLoadCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1391

          +

          Defined in node_modules/@types/react/index.d.ts:1393


          Optional onLoadStart#

          onLoadStart? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadStart

          -

          Defined in node_modules/@types/react/index.d.ts:1422

          +

          Defined in node_modules/@types/react/index.d.ts:1424


          Optional onLoadStartCapture#

          onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1423

          +

          Defined in node_modules/@types/react/index.d.ts:1425


          Optional onLoadedData#

          onLoadedData? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadedData

          -

          Defined in node_modules/@types/react/index.d.ts:1418

          +

          Defined in node_modules/@types/react/index.d.ts:1420


          Optional onLoadedDataCapture#

          onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadedDataCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1419

          +

          Defined in node_modules/@types/react/index.d.ts:1421


          Optional onLoadedMetadata#

          onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadedMetadata

          -

          Defined in node_modules/@types/react/index.d.ts:1420

          +

          Defined in node_modules/@types/react/index.d.ts:1422


          Optional onLoadedMetadataCapture#

          onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadedMetadataCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1421

          +

          Defined in node_modules/@types/react/index.d.ts:1423


          Optional onLostPointerCapture#

          onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLostPointerCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1520

          +

          Defined in node_modules/@types/react/index.d.ts:1522


          Optional onLostPointerCaptureCapture#

          onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLostPointerCaptureCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1521

          +

          Defined in node_modules/@types/react/index.d.ts:1523


          Optional onMouseDown#

          onMouseDown? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseDown

          -

          Defined in node_modules/@types/react/index.d.ts:1474

          +

          Defined in node_modules/@types/react/index.d.ts:1476


          Optional onMouseDownCapture#

          onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1475

          +

          Defined in node_modules/@types/react/index.d.ts:1477


          Optional onMouseEnter#

          onMouseEnter? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1476

          +

          Defined in node_modules/@types/react/index.d.ts:1478


          Optional onMouseLeave#

          onMouseLeave? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1477

          +

          Defined in node_modules/@types/react/index.d.ts:1479


          Optional onMouseMove#

          onMouseMove? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseMove

          -

          Defined in node_modules/@types/react/index.d.ts:1478

          +

          Defined in node_modules/@types/react/index.d.ts:1480


          Optional onMouseMoveCapture#

          onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1479

          +

          Defined in node_modules/@types/react/index.d.ts:1481


          Optional onMouseOut#

          onMouseOut? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseOut

          -

          Defined in node_modules/@types/react/index.d.ts:1480

          +

          Defined in node_modules/@types/react/index.d.ts:1482


          Optional onMouseOutCapture#

          onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseOutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1481

          +

          Defined in node_modules/@types/react/index.d.ts:1483


          Optional onMouseOver#

          onMouseOver? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseOver

          -

          Defined in node_modules/@types/react/index.d.ts:1482

          +

          Defined in node_modules/@types/react/index.d.ts:1484


          Optional onMouseOverCapture#

          onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1483

          +

          Defined in node_modules/@types/react/index.d.ts:1485


          Optional onMouseUp#

          onMouseUp? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseUp

          -

          Defined in node_modules/@types/react/index.d.ts:1484

          +

          Defined in node_modules/@types/react/index.d.ts:1486


          Optional onMouseUpCapture#

          onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1485

          +

          Defined in node_modules/@types/react/index.d.ts:1487


          Optional onPaste#

          onPaste? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPaste

          -

          Defined in node_modules/@types/react/index.d.ts:1358

          +

          Defined in node_modules/@types/react/index.d.ts:1360


          Optional onPasteCapture#

          onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPasteCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1359

          +

          Defined in node_modules/@types/react/index.d.ts:1361


          Optional onPause#

          onPause? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPause

          -

          Defined in node_modules/@types/react/index.d.ts:1424

          +

          Defined in node_modules/@types/react/index.d.ts:1426


          Optional onPauseCapture#

          onPauseCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPauseCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1425

          +

          Defined in node_modules/@types/react/index.d.ts:1427


          Optional onPlay#

          onPlay? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1426

          +

          Defined in node_modules/@types/react/index.d.ts:1428


          Optional onPlayCapture#

          onPlayCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPlayCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1427

          +

          Defined in node_modules/@types/react/index.d.ts:1429


          Optional onPlaying#

          onPlaying? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPlaying

          -

          Defined in node_modules/@types/react/index.d.ts:1428

          +

          Defined in node_modules/@types/react/index.d.ts:1430


          Optional onPlayingCapture#

          onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPlayingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1429

          +

          Defined in node_modules/@types/react/index.d.ts:1431


          Optional onPointerCancel#

          onPointerCancel? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerCancel

          -

          Defined in node_modules/@types/react/index.d.ts:1508

          +

          Defined in node_modules/@types/react/index.d.ts:1510


          Optional onPointerCancelCapture#

          onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerCancelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1509

          +

          Defined in node_modules/@types/react/index.d.ts:1511


          Optional onPointerDown#

          onPointerDown? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerDown

          -

          Defined in node_modules/@types/react/index.d.ts:1502

          +

          Defined in node_modules/@types/react/index.d.ts:1504


          Optional onPointerDownCapture#

          onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1503

          +

          Defined in node_modules/@types/react/index.d.ts:1505


          Optional onPointerEnter#

          onPointerEnter? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1510

          +

          Defined in node_modules/@types/react/index.d.ts:1512


          Optional onPointerEnterCapture#

          onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerEnterCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1511

          +

          Defined in node_modules/@types/react/index.d.ts:1513


          Optional onPointerLeave#

          onPointerLeave? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1512

          +

          Defined in node_modules/@types/react/index.d.ts:1514


          Optional onPointerLeaveCapture#

          onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerLeaveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1513

          +

          Defined in node_modules/@types/react/index.d.ts:1515


          Optional onPointerMove#

          onPointerMove? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerMove

          -

          Defined in node_modules/@types/react/index.d.ts:1504

          +

          Defined in node_modules/@types/react/index.d.ts:1506


          Optional onPointerMoveCapture#

          onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1505

          +

          Defined in node_modules/@types/react/index.d.ts:1507


          Optional onPointerOut#

          onPointerOut? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerOut

          -

          Defined in node_modules/@types/react/index.d.ts:1516

          +

          Defined in node_modules/@types/react/index.d.ts:1518


          Optional onPointerOutCapture#

          onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerOutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1517

          +

          Defined in node_modules/@types/react/index.d.ts:1519


          Optional onPointerOver#

          onPointerOver? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerOver

          -

          Defined in node_modules/@types/react/index.d.ts:1514

          +

          Defined in node_modules/@types/react/index.d.ts:1516


          Optional onPointerOverCapture#

          onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1515

          +

          Defined in node_modules/@types/react/index.d.ts:1517


          Optional onPointerUp#

          onPointerUp? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerUp

          -

          Defined in node_modules/@types/react/index.d.ts:1506

          +

          Defined in node_modules/@types/react/index.d.ts:1508


          Optional onPointerUpCapture#

          onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1507

          +

          Defined in node_modules/@types/react/index.d.ts:1509


          Optional onProgress#

          onProgress? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onProgress

          -

          Defined in node_modules/@types/react/index.d.ts:1430

          +

          Defined in node_modules/@types/react/index.d.ts:1432


          Optional onProgressCapture#

          onProgressCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onProgressCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1431

          +

          Defined in node_modules/@types/react/index.d.ts:1433


          Optional onRateChange#

          onRateChange? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onRateChange

          -

          Defined in node_modules/@types/react/index.d.ts:1432

          +

          Defined in node_modules/@types/react/index.d.ts:1434


          Optional onRateChangeCapture#

          onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onRateChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1433

          +

          Defined in node_modules/@types/react/index.d.ts:1435


          Optional onReset#

          onReset? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onReset

          -

          Defined in node_modules/@types/react/index.d.ts:1382

          +

          Defined in node_modules/@types/react/index.d.ts:1384


          Optional onResetCapture#

          onResetCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onResetCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1383

          +

          Defined in node_modules/@types/react/index.d.ts:1385


          Optional onScroll#

          onScroll? : UIEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onScroll

          -

          Defined in node_modules/@types/react/index.d.ts:1524

          +

          Defined in node_modules/@types/react/index.d.ts:1526


          Optional onScrollCapture#

          onScrollCapture? : UIEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onScrollCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1525

          +

          Defined in node_modules/@types/react/index.d.ts:1527


          Optional onSeeked#

          onSeeked? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSeeked

          -

          Defined in node_modules/@types/react/index.d.ts:1434

          +

          Defined in node_modules/@types/react/index.d.ts:1436


          Optional onSeekedCapture#

          onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSeekedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1435

          +

          Defined in node_modules/@types/react/index.d.ts:1437


          Optional onSeeking#

          onSeeking? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSeeking

          -

          Defined in node_modules/@types/react/index.d.ts:1436

          +

          Defined in node_modules/@types/react/index.d.ts:1438


          Optional onSeekingCapture#

          onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSeekingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1437

          +

          Defined in node_modules/@types/react/index.d.ts:1439


          Optional onSelect#

          onSelect? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSelect

          -

          Defined in node_modules/@types/react/index.d.ts:1488

          +

          Defined in node_modules/@types/react/index.d.ts:1490


          Optional onSelectCapture#

          onSelectCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSelectCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1489

          +

          Defined in node_modules/@types/react/index.d.ts:1491


          Optional onStalled#

          onStalled? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onStalled

          -

          Defined in node_modules/@types/react/index.d.ts:1438

          +

          Defined in node_modules/@types/react/index.d.ts:1440


          Optional onStalledCapture#

          onStalledCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onStalledCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1439

          +

          Defined in node_modules/@types/react/index.d.ts:1441


          Optional onSubmit#

          onSubmit? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSubmit

          -

          Defined in node_modules/@types/react/index.d.ts:1384

          +

          Defined in node_modules/@types/react/index.d.ts:1386


          Optional onSubmitCapture#

          onSubmitCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSubmitCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1385

          +

          Defined in node_modules/@types/react/index.d.ts:1387


          Optional onSuspend#

          onSuspend? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSuspend

          -

          Defined in node_modules/@types/react/index.d.ts:1440

          +

          Defined in node_modules/@types/react/index.d.ts:1442


          Optional onSuspendCapture#

          onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSuspendCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1441

          +

          Defined in node_modules/@types/react/index.d.ts:1443


          Optional onTimeUpdate#

          onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTimeUpdate

          -

          Defined in node_modules/@types/react/index.d.ts:1442

          +

          Defined in node_modules/@types/react/index.d.ts:1444


          Optional onTimeUpdateCapture#

          onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTimeUpdateCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1443

          +

          Defined in node_modules/@types/react/index.d.ts:1445


          Optional onTouchCancel#

          onTouchCancel? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchCancel

          -

          Defined in node_modules/@types/react/index.d.ts:1492

          +

          Defined in node_modules/@types/react/index.d.ts:1494


          Optional onTouchCancelCapture#

          onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchCancelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1493

          +

          Defined in node_modules/@types/react/index.d.ts:1495


          Optional onTouchEnd#

          onTouchEnd? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1494

          +

          Defined in node_modules/@types/react/index.d.ts:1496


          Optional onTouchEndCapture#

          onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1495

          +

          Defined in node_modules/@types/react/index.d.ts:1497


          Optional onTouchMove#

          onTouchMove? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchMove

          -

          Defined in node_modules/@types/react/index.d.ts:1496

          +

          Defined in node_modules/@types/react/index.d.ts:1498


          Optional onTouchMoveCapture#

          onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1497

          +

          Defined in node_modules/@types/react/index.d.ts:1499


          Optional onTouchStart#

          onTouchStart? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchStart

          -

          Defined in node_modules/@types/react/index.d.ts:1498

          +

          Defined in node_modules/@types/react/index.d.ts:1500


          Optional onTouchStartCapture#

          onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1499

          +

          Defined in node_modules/@types/react/index.d.ts:1501


          Optional onTransitionEnd#

          onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTransitionEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1540

          +

          Defined in node_modules/@types/react/index.d.ts:1542


          Optional onTransitionEndCapture#

          onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTransitionEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1541

          +

          Defined in node_modules/@types/react/index.d.ts:1543


          Optional onVolumeChange#

          onVolumeChange? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onVolumeChange

          -

          Defined in node_modules/@types/react/index.d.ts:1444

          +

          Defined in node_modules/@types/react/index.d.ts:1446


          Optional onVolumeChangeCapture#

          onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onVolumeChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1445

          +

          Defined in node_modules/@types/react/index.d.ts:1447


          Optional onWaiting#

          onWaiting? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onWaiting

          -

          Defined in node_modules/@types/react/index.d.ts:1446

          +

          Defined in node_modules/@types/react/index.d.ts:1448


          Optional onWaitingCapture#

          onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onWaitingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1447

          +

          Defined in node_modules/@types/react/index.d.ts:1449


          Optional onWheel#

          onWheel? : WheelEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onWheel

          -

          Defined in node_modules/@types/react/index.d.ts:1528

          +

          Defined in node_modules/@types/react/index.d.ts:1530


          Optional onWheelCapture#

          onWheelCapture? : WheelEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onWheelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1529

          +

          Defined in node_modules/@types/react/index.d.ts:1531


          Optional renderBoolean#

          renderBoolean? : boolean

          -

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

          +

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

          +
          +

          Optional showWithColumn#

          +

          showWithColumn? : string

          +

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


          Optional sortBy#

          sortBy? : TableSortBy

          -

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

          +

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


          Optional title#

          title? : ReactNode

          -

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

          +

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

          Methods#

          Optional _sort#

          _sort(sortBy: TableSortBy): void

          -

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

          +

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

          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 8721df8e5d..38455c435d 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -2209,16 +2209,16 @@

      Optional children#

      children? : ReactNode

      Inherited from PageLayoutProps.children

      -

      Defined in node_modules/@types/react/index.d.ts:1348

      +

      Defined in node_modules/@types/react/index.d.ts:1350


      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

      Inherited from PageLayoutProps.dangerouslySetInnerHTML

      -

      Defined in node_modules/@types/react/index.d.ts:1349

      +

      Defined in node_modules/@types/react/index.d.ts:1351

      Type declaration:

      • __html: string
      • @@ -2226,815 +2226,815 @@

        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›

        Inherited from PageLayoutProps.onAbort

        -

        Defined in node_modules/@types/react/index.d.ts:1404

        +

        Defined in node_modules/@types/react/index.d.ts:1406


        Optional onAbortCapture#

        onAbortCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAbortCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1405

        +

        Defined in node_modules/@types/react/index.d.ts:1407


        Optional onAnimationEnd#

        onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAnimationEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1534

        +

        Defined in node_modules/@types/react/index.d.ts:1536


        Optional onAnimationEndCapture#

        onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAnimationEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1535

        +

        Defined in node_modules/@types/react/index.d.ts:1537


        Optional onAnimationIteration#

        onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAnimationIteration

        -

        Defined in node_modules/@types/react/index.d.ts:1536

        +

        Defined in node_modules/@types/react/index.d.ts:1538


        Optional onAnimationIterationCapture#

        onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAnimationIterationCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1537

        +

        Defined in node_modules/@types/react/index.d.ts:1539


        Optional onAnimationStart#

        onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAnimationStart

        -

        Defined in node_modules/@types/react/index.d.ts:1532

        +

        Defined in node_modules/@types/react/index.d.ts:1534


        Optional onAnimationStartCapture#

        onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAnimationStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1533

        +

        Defined in node_modules/@types/react/index.d.ts:1535


        Optional onAuxClick#

        onAuxClick? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAuxClick

        -

        Defined in node_modules/@types/react/index.d.ts:1450

        +

        Defined in node_modules/@types/react/index.d.ts:1452


        Optional onAuxClickCapture#

        onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onAuxClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1451

        +

        Defined in node_modules/@types/react/index.d.ts:1453


        Optional onBeforeInput#

        onBeforeInput? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onBeforeInput

        -

        Defined in node_modules/@types/react/index.d.ts:1378

        +

        Defined in node_modules/@types/react/index.d.ts:1380


        Optional onBeforeInputCapture#

        onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onBeforeInputCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1379

        +

        Defined in node_modules/@types/react/index.d.ts:1381


        Optional onBlur#

        onBlur? : FocusEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onBlur

        -

        Defined in node_modules/@types/react/index.d.ts:1372

        +

        Defined in node_modules/@types/react/index.d.ts:1374


        Optional onBlurCapture#

        onBlurCapture? : FocusEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onBlurCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1373

        +

        Defined in node_modules/@types/react/index.d.ts:1375


        Optional onCanPlay#

        onCanPlay? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCanPlay

        -

        Defined in node_modules/@types/react/index.d.ts:1406

        +

        Defined in node_modules/@types/react/index.d.ts:1408


        Optional onCanPlayCapture#

        onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCanPlayCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1407

        +

        Defined in node_modules/@types/react/index.d.ts:1409


        Optional onCanPlayThrough#

        onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCanPlayThrough

        -

        Defined in node_modules/@types/react/index.d.ts:1408

        +

        Defined in node_modules/@types/react/index.d.ts:1410


        Optional onCanPlayThroughCapture#

        onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCanPlayThroughCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1409

        +

        Defined in node_modules/@types/react/index.d.ts:1411


        Optional onChange#

        onChange? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onChange

        -

        Defined in node_modules/@types/react/index.d.ts:1376

        +

        Defined in node_modules/@types/react/index.d.ts:1378


        Optional onChangeCapture#

        onChangeCapture? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1377

        +

        Defined in node_modules/@types/react/index.d.ts:1379


        Optional onClick#

        onClick? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onClick

        -

        Defined in node_modules/@types/react/index.d.ts:1452

        +

        Defined in node_modules/@types/react/index.d.ts:1454


        Optional onClickCapture#

        onClickCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1453

        +

        Defined in node_modules/@types/react/index.d.ts:1455


        Optional onCompositionEnd#

        onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCompositionEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1362

        +

        Defined in node_modules/@types/react/index.d.ts:1364


        Optional onCompositionEndCapture#

        onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCompositionEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1363

        +

        Defined in node_modules/@types/react/index.d.ts:1365


        Optional onCompositionStart#

        onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCompositionStart

        -

        Defined in node_modules/@types/react/index.d.ts:1364

        +

        Defined in node_modules/@types/react/index.d.ts:1366


        Optional onCompositionStartCapture#

        onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCompositionStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1365

        +

        Defined in node_modules/@types/react/index.d.ts:1367


        Optional onCompositionUpdate#

        onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCompositionUpdate

        -

        Defined in node_modules/@types/react/index.d.ts:1366

        +

        Defined in node_modules/@types/react/index.d.ts:1368


        Optional onCompositionUpdateCapture#

        onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCompositionUpdateCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1367

        +

        Defined in node_modules/@types/react/index.d.ts:1369


        Optional onContextMenu#

        onContextMenu? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onContextMenu

        -

        Defined in node_modules/@types/react/index.d.ts:1454

        +

        Defined in node_modules/@types/react/index.d.ts:1456


        Optional onContextMenuCapture#

        onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onContextMenuCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1455

        +

        Defined in node_modules/@types/react/index.d.ts:1457


        Optional onCopy#

        onCopy? : ClipboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCopy

        -

        Defined in node_modules/@types/react/index.d.ts:1354

        +

        Defined in node_modules/@types/react/index.d.ts:1356


        Optional onCopyCapture#

        onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCopyCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1355

        +

        Defined in node_modules/@types/react/index.d.ts:1357


        Optional onCut#

        onCut? : ClipboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCut

        -

        Defined in node_modules/@types/react/index.d.ts:1356

        +

        Defined in node_modules/@types/react/index.d.ts:1358


        Optional onCutCapture#

        onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onCutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1357

        +

        Defined in node_modules/@types/react/index.d.ts:1359


        Optional onDoubleClick#

        onDoubleClick? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDoubleClick

        -

        Defined in node_modules/@types/react/index.d.ts:1456

        +

        Defined in node_modules/@types/react/index.d.ts:1458


        Optional onDoubleClickCapture#

        onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDoubleClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1457

        +

        Defined in node_modules/@types/react/index.d.ts:1459


        Optional onDrag#

        onDrag? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDrag

        -

        Defined in node_modules/@types/react/index.d.ts:1458

        +

        Defined in node_modules/@types/react/index.d.ts:1460


        Optional onDragCapture#

        onDragCapture? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1459

        +

        Defined in node_modules/@types/react/index.d.ts:1461


        Optional onDragEnd#

        onDragEnd? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1460

        +

        Defined in node_modules/@types/react/index.d.ts:1462


        Optional onDragEndCapture#

        onDragEndCapture? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1461

        +

        Defined in node_modules/@types/react/index.d.ts:1463


        Optional onDragEnter#

        onDragEnter? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1462

        +

        Defined in node_modules/@types/react/index.d.ts:1464


        Optional onDragEnterCapture#

        onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragEnterCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1463

        +

        Defined in node_modules/@types/react/index.d.ts:1465


        Optional onDragExit#

        onDragExit? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragExit

        -

        Defined in node_modules/@types/react/index.d.ts:1464

        +

        Defined in node_modules/@types/react/index.d.ts:1466


        Optional onDragExitCapture#

        onDragExitCapture? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragExitCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1465

        +

        Defined in node_modules/@types/react/index.d.ts:1467


        Optional onDragLeave#

        onDragLeave? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1466

        +

        Defined in node_modules/@types/react/index.d.ts:1468


        Optional onDragLeaveCapture#

        onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragLeaveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1467

        +

        Defined in node_modules/@types/react/index.d.ts:1469


        Optional onDragOver#

        onDragOver? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragOver

        -

        Defined in node_modules/@types/react/index.d.ts:1468

        +

        Defined in node_modules/@types/react/index.d.ts:1470


        Optional onDragOverCapture#

        onDragOverCapture? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1469

        +

        Defined in node_modules/@types/react/index.d.ts:1471


        Optional onDragStart#

        onDragStart? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragStart

        -

        Defined in node_modules/@types/react/index.d.ts:1470

        +

        Defined in node_modules/@types/react/index.d.ts:1472


        Optional onDragStartCapture#

        onDragStartCapture? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDragStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1471

        +

        Defined in node_modules/@types/react/index.d.ts:1473


        Optional onDrop#

        onDrop? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDrop

        -

        Defined in node_modules/@types/react/index.d.ts:1472

        +

        Defined in node_modules/@types/react/index.d.ts:1474


        Optional onDropCapture#

        onDropCapture? : DragEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDropCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1473

        +

        Defined in node_modules/@types/react/index.d.ts:1475


        Optional onDurationChange#

        onDurationChange? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDurationChange

        -

        Defined in node_modules/@types/react/index.d.ts:1410

        +

        Defined in node_modules/@types/react/index.d.ts:1412


        Optional onDurationChangeCapture#

        onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onDurationChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1411

        +

        Defined in node_modules/@types/react/index.d.ts:1413


        Optional onEmptied#

        onEmptied? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onEmptied

        -

        Defined in node_modules/@types/react/index.d.ts:1412

        +

        Defined in node_modules/@types/react/index.d.ts:1414


        Optional onEmptiedCapture#

        onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onEmptiedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1413

        +

        Defined in node_modules/@types/react/index.d.ts:1415


        Optional onEncrypted#

        onEncrypted? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onEncrypted

        -

        Defined in node_modules/@types/react/index.d.ts:1414

        +

        Defined in node_modules/@types/react/index.d.ts:1416


        Optional onEncryptedCapture#

        onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onEncryptedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1415

        +

        Defined in node_modules/@types/react/index.d.ts:1417


        Optional onEnded#

        onEnded? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onEnded

        -

        Defined in node_modules/@types/react/index.d.ts:1416

        +

        Defined in node_modules/@types/react/index.d.ts:1418


        Optional onEndedCapture#

        onEndedCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onEndedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1417

        +

        Defined in node_modules/@types/react/index.d.ts:1419


        Optional onError#

        onError? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onError

        -

        Defined in node_modules/@types/react/index.d.ts:1392

        +

        Defined in node_modules/@types/react/index.d.ts:1394


        Optional onErrorCapture#

        onErrorCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onErrorCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1393

        +

        Defined in node_modules/@types/react/index.d.ts:1395


        Optional onFocus#

        onFocus? : FocusEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onFocus

        -

        Defined in node_modules/@types/react/index.d.ts:1370

        +

        Defined in node_modules/@types/react/index.d.ts:1372


        Optional onFocusCapture#

        onFocusCapture? : FocusEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onFocusCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1371

        +

        Defined in node_modules/@types/react/index.d.ts:1373


        Optional onGotPointerCapture#

        onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onGotPointerCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1518

        +

        Defined in node_modules/@types/react/index.d.ts:1520


        Optional onGotPointerCaptureCapture#

        onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onGotPointerCaptureCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1519

        +

        Defined in node_modules/@types/react/index.d.ts:1521


        Optional onInput#

        onInput? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onInput

        -

        Defined in node_modules/@types/react/index.d.ts:1380

        +

        Defined in node_modules/@types/react/index.d.ts:1382


        Optional onInputCapture#

        onInputCapture? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onInputCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1381

        +

        Defined in node_modules/@types/react/index.d.ts:1383


        Optional onInvalid#

        onInvalid? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onInvalid

        -

        Defined in node_modules/@types/react/index.d.ts:1386

        +

        Defined in node_modules/@types/react/index.d.ts:1388


        Optional onInvalidCapture#

        onInvalidCapture? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onInvalidCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1387

        +

        Defined in node_modules/@types/react/index.d.ts:1389


        Optional onKeyDown#

        onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onKeyDown

        -

        Defined in node_modules/@types/react/index.d.ts:1396

        +

        Defined in node_modules/@types/react/index.d.ts:1398


        Optional onKeyDownCapture#

        onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onKeyDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1397

        +

        Defined in node_modules/@types/react/index.d.ts:1399


        Optional onKeyPress#

        onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onKeyPress

        -

        Defined in node_modules/@types/react/index.d.ts:1398

        +

        Defined in node_modules/@types/react/index.d.ts:1400


        Optional onKeyPressCapture#

        onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onKeyPressCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1399

        +

        Defined in node_modules/@types/react/index.d.ts:1401


        Optional onKeyUp#

        onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onKeyUp

        -

        Defined in node_modules/@types/react/index.d.ts:1400

        +

        Defined in node_modules/@types/react/index.d.ts:1402


        Optional onKeyUpCapture#

        onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onKeyUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1401

        +

        Defined in node_modules/@types/react/index.d.ts:1403


        Optional onLoad#

        onLoad? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLoad

        -

        Defined in node_modules/@types/react/index.d.ts:1390

        +

        Defined in node_modules/@types/react/index.d.ts:1392


        Optional onLoadCapture#

        onLoadCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLoadCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1391

        +

        Defined in node_modules/@types/react/index.d.ts:1393


        Optional onLoadStart#

        onLoadStart? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLoadStart

        -

        Defined in node_modules/@types/react/index.d.ts:1422

        +

        Defined in node_modules/@types/react/index.d.ts:1424


        Optional onLoadStartCapture#

        onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLoadStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1423

        +

        Defined in node_modules/@types/react/index.d.ts:1425


        Optional onLoadedData#

        onLoadedData? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLoadedData

        -

        Defined in node_modules/@types/react/index.d.ts:1418

        +

        Defined in node_modules/@types/react/index.d.ts:1420


        Optional onLoadedDataCapture#

        onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLoadedDataCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1419

        +

        Defined in node_modules/@types/react/index.d.ts:1421


        Optional onLoadedMetadata#

        onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLoadedMetadata

        -

        Defined in node_modules/@types/react/index.d.ts:1420

        +

        Defined in node_modules/@types/react/index.d.ts:1422


        Optional onLoadedMetadataCapture#

        onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLoadedMetadataCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1421

        +

        Defined in node_modules/@types/react/index.d.ts:1423


        Optional onLostPointerCapture#

        onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLostPointerCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1520

        +

        Defined in node_modules/@types/react/index.d.ts:1522


        Optional onLostPointerCaptureCapture#

        onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onLostPointerCaptureCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1521

        +

        Defined in node_modules/@types/react/index.d.ts:1523


        Optional onMouseDown#

        onMouseDown? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseDown

        -

        Defined in node_modules/@types/react/index.d.ts:1474

        +

        Defined in node_modules/@types/react/index.d.ts:1476


        Optional onMouseDownCapture#

        onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1475

        +

        Defined in node_modules/@types/react/index.d.ts:1477


        Optional onMouseEnter#

        onMouseEnter? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1476

        +

        Defined in node_modules/@types/react/index.d.ts:1478


        Optional onMouseLeave#

        onMouseLeave? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1477

        +

        Defined in node_modules/@types/react/index.d.ts:1479


        Optional onMouseMove#

        onMouseMove? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseMove

        -

        Defined in node_modules/@types/react/index.d.ts:1478

        +

        Defined in node_modules/@types/react/index.d.ts:1480


        Optional onMouseMoveCapture#

        onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1479

        +

        Defined in node_modules/@types/react/index.d.ts:1481


        Optional onMouseOut#

        onMouseOut? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseOut

        -

        Defined in node_modules/@types/react/index.d.ts:1480

        +

        Defined in node_modules/@types/react/index.d.ts:1482


        Optional onMouseOutCapture#

        onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseOutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1481

        +

        Defined in node_modules/@types/react/index.d.ts:1483


        Optional onMouseOver#

        onMouseOver? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseOver

        -

        Defined in node_modules/@types/react/index.d.ts:1482

        +

        Defined in node_modules/@types/react/index.d.ts:1484


        Optional onMouseOverCapture#

        onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1483

        +

        Defined in node_modules/@types/react/index.d.ts:1485


        Optional onMouseUp#

        onMouseUp? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseUp

        -

        Defined in node_modules/@types/react/index.d.ts:1484

        +

        Defined in node_modules/@types/react/index.d.ts:1486


        Optional onMouseUpCapture#

        onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onMouseUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1485

        +

        Defined in node_modules/@types/react/index.d.ts:1487


        Optional onPaste#

        onPaste? : ClipboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPaste

        -

        Defined in node_modules/@types/react/index.d.ts:1358

        +

        Defined in node_modules/@types/react/index.d.ts:1360


        Optional onPasteCapture#

        onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPasteCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1359

        +

        Defined in node_modules/@types/react/index.d.ts:1361


        Optional onPause#

        onPause? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPause

        -

        Defined in node_modules/@types/react/index.d.ts:1424

        +

        Defined in node_modules/@types/react/index.d.ts:1426


        Optional onPauseCapture#

        onPauseCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPauseCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1425

        +

        Defined in node_modules/@types/react/index.d.ts:1427


        Optional onPlay#

        onPlay? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPlay

        -

        Defined in node_modules/@types/react/index.d.ts:1426

        +

        Defined in node_modules/@types/react/index.d.ts:1428


        Optional onPlayCapture#

        onPlayCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPlayCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1427

        +

        Defined in node_modules/@types/react/index.d.ts:1429


        Optional onPlaying#

        onPlaying? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPlaying

        -

        Defined in node_modules/@types/react/index.d.ts:1428

        +

        Defined in node_modules/@types/react/index.d.ts:1430


        Optional onPlayingCapture#

        onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPlayingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1429

        +

        Defined in node_modules/@types/react/index.d.ts:1431


        Optional onPointerCancel#

        onPointerCancel? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerCancel

        -

        Defined in node_modules/@types/react/index.d.ts:1508

        +

        Defined in node_modules/@types/react/index.d.ts:1510


        Optional onPointerCancelCapture#

        onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerCancelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1509

        +

        Defined in node_modules/@types/react/index.d.ts:1511


        Optional onPointerDown#

        onPointerDown? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerDown

        -

        Defined in node_modules/@types/react/index.d.ts:1502

        +

        Defined in node_modules/@types/react/index.d.ts:1504


        Optional onPointerDownCapture#

        onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1503

        +

        Defined in node_modules/@types/react/index.d.ts:1505


        Optional onPointerEnter#

        onPointerEnter? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1510

        +

        Defined in node_modules/@types/react/index.d.ts:1512


        Optional onPointerEnterCapture#

        onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerEnterCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1511

        +

        Defined in node_modules/@types/react/index.d.ts:1513


        Optional onPointerLeave#

        onPointerLeave? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1512

        +

        Defined in node_modules/@types/react/index.d.ts:1514


        Optional onPointerLeaveCapture#

        onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerLeaveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1513

        +

        Defined in node_modules/@types/react/index.d.ts:1515


        Optional onPointerMove#

        onPointerMove? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerMove

        -

        Defined in node_modules/@types/react/index.d.ts:1504

        +

        Defined in node_modules/@types/react/index.d.ts:1506


        Optional onPointerMoveCapture#

        onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1505

        +

        Defined in node_modules/@types/react/index.d.ts:1507


        Optional onPointerOut#

        onPointerOut? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerOut

        -

        Defined in node_modules/@types/react/index.d.ts:1516

        +

        Defined in node_modules/@types/react/index.d.ts:1518


        Optional onPointerOutCapture#

        onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerOutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1517

        +

        Defined in node_modules/@types/react/index.d.ts:1519


        Optional onPointerOver#

        onPointerOver? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerOver

        -

        Defined in node_modules/@types/react/index.d.ts:1514

        +

        Defined in node_modules/@types/react/index.d.ts:1516


        Optional onPointerOverCapture#

        onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1515

        +

        Defined in node_modules/@types/react/index.d.ts:1517


        Optional onPointerUp#

        onPointerUp? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerUp

        -

        Defined in node_modules/@types/react/index.d.ts:1506

        +

        Defined in node_modules/@types/react/index.d.ts:1508


        Optional onPointerUpCapture#

        onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onPointerUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1507

        +

        Defined in node_modules/@types/react/index.d.ts:1509


        Optional onProgress#

        onProgress? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onProgress

        -

        Defined in node_modules/@types/react/index.d.ts:1430

        +

        Defined in node_modules/@types/react/index.d.ts:1432


        Optional onProgressCapture#

        onProgressCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onProgressCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1431

        +

        Defined in node_modules/@types/react/index.d.ts:1433


        Optional onRateChange#

        onRateChange? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onRateChange

        -

        Defined in node_modules/@types/react/index.d.ts:1432

        +

        Defined in node_modules/@types/react/index.d.ts:1434


        Optional onRateChangeCapture#

        onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onRateChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1433

        +

        Defined in node_modules/@types/react/index.d.ts:1435


        Optional onReset#

        onReset? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onReset

        -

        Defined in node_modules/@types/react/index.d.ts:1382

        +

        Defined in node_modules/@types/react/index.d.ts:1384


        Optional onResetCapture#

        onResetCapture? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onResetCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1383

        +

        Defined in node_modules/@types/react/index.d.ts:1385


        Optional onScroll#

        onScroll? : UIEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onScroll

        -

        Defined in node_modules/@types/react/index.d.ts:1524

        +

        Defined in node_modules/@types/react/index.d.ts:1526


        Optional onScrollCapture#

        onScrollCapture? : UIEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onScrollCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1525

        +

        Defined in node_modules/@types/react/index.d.ts:1527


        Optional onSeeked#

        onSeeked? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSeeked

        -

        Defined in node_modules/@types/react/index.d.ts:1434

        +

        Defined in node_modules/@types/react/index.d.ts:1436


        Optional onSeekedCapture#

        onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSeekedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1435

        +

        Defined in node_modules/@types/react/index.d.ts:1437


        Optional onSeeking#

        onSeeking? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSeeking

        -

        Defined in node_modules/@types/react/index.d.ts:1436

        +

        Defined in node_modules/@types/react/index.d.ts:1438


        Optional onSeekingCapture#

        onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSeekingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1437

        +

        Defined in node_modules/@types/react/index.d.ts:1439


        Optional onSelect#

        onSelect? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSelect

        -

        Defined in node_modules/@types/react/index.d.ts:1488

        +

        Defined in node_modules/@types/react/index.d.ts:1490


        Optional onSelectCapture#

        onSelectCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSelectCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1489

        +

        Defined in node_modules/@types/react/index.d.ts:1491


        Optional onStalled#

        onStalled? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onStalled

        -

        Defined in node_modules/@types/react/index.d.ts:1438

        +

        Defined in node_modules/@types/react/index.d.ts:1440


        Optional onStalledCapture#

        onStalledCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onStalledCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1439

        +

        Defined in node_modules/@types/react/index.d.ts:1441


        Optional onSubmit#

        onSubmit? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSubmit

        -

        Defined in node_modules/@types/react/index.d.ts:1384

        +

        Defined in node_modules/@types/react/index.d.ts:1386


        Optional onSubmitCapture#

        onSubmitCapture? : FormEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSubmitCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1385

        +

        Defined in node_modules/@types/react/index.d.ts:1387


        Optional onSuspend#

        onSuspend? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSuspend

        -

        Defined in node_modules/@types/react/index.d.ts:1440

        +

        Defined in node_modules/@types/react/index.d.ts:1442


        Optional onSuspendCapture#

        onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onSuspendCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1441

        +

        Defined in node_modules/@types/react/index.d.ts:1443


        Optional onTimeUpdate#

        onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTimeUpdate

        -

        Defined in node_modules/@types/react/index.d.ts:1442

        +

        Defined in node_modules/@types/react/index.d.ts:1444


        Optional onTimeUpdateCapture#

        onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTimeUpdateCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1443

        +

        Defined in node_modules/@types/react/index.d.ts:1445


        Optional onTouchCancel#

        onTouchCancel? : TouchEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTouchCancel

        -

        Defined in node_modules/@types/react/index.d.ts:1492

        +

        Defined in node_modules/@types/react/index.d.ts:1494


        Optional onTouchCancelCapture#

        onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTouchCancelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1493

        +

        Defined in node_modules/@types/react/index.d.ts:1495


        Optional onTouchEnd#

        onTouchEnd? : TouchEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTouchEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1494

        +

        Defined in node_modules/@types/react/index.d.ts:1496


        Optional onTouchEndCapture#

        onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTouchEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1495

        +

        Defined in node_modules/@types/react/index.d.ts:1497


        Optional onTouchMove#

        onTouchMove? : TouchEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTouchMove

        -

        Defined in node_modules/@types/react/index.d.ts:1496

        +

        Defined in node_modules/@types/react/index.d.ts:1498


        Optional onTouchMoveCapture#

        onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTouchMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1497

        +

        Defined in node_modules/@types/react/index.d.ts:1499


        Optional onTouchStart#

        onTouchStart? : TouchEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTouchStart

        -

        Defined in node_modules/@types/react/index.d.ts:1498

        +

        Defined in node_modules/@types/react/index.d.ts:1500


        Optional onTouchStartCapture#

        onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTouchStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1499

        +

        Defined in node_modules/@types/react/index.d.ts:1501


        Optional onTransitionEnd#

        onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTransitionEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1540

        +

        Defined in node_modules/@types/react/index.d.ts:1542


        Optional onTransitionEndCapture#

        onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onTransitionEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1541

        +

        Defined in node_modules/@types/react/index.d.ts:1543


        Optional onVolumeChange#

        onVolumeChange? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onVolumeChange

        -

        Defined in node_modules/@types/react/index.d.ts:1444

        +

        Defined in node_modules/@types/react/index.d.ts:1446


        Optional onVolumeChangeCapture#

        onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onVolumeChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1445

        +

        Defined in node_modules/@types/react/index.d.ts:1447


        Optional onWaiting#

        onWaiting? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onWaiting

        -

        Defined in node_modules/@types/react/index.d.ts:1446

        +

        Defined in node_modules/@types/react/index.d.ts:1448


        Optional onWaitingCapture#

        onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onWaitingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1447

        +

        Defined in node_modules/@types/react/index.d.ts:1449


        Optional onWheel#

        onWheel? : WheelEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onWheel

        -

        Defined in node_modules/@types/react/index.d.ts:1528

        +

        Defined in node_modules/@types/react/index.d.ts:1530


        Optional onWheelCapture#

        onWheelCapture? : WheelEventHandler‹HTMLDivElement›

        Inherited from PageLayoutProps.onWheelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1529

        +

        Defined in node_modules/@types/react/index.d.ts:1531


        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 4d2c204a05..c883fdc016 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -2312,20 +2312,20 @@

        Properties#

        Optional autoSize#

        autoSize? : boolean

        -

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

        +

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


        Optional children#

        children? : ReactNode

        Inherited from PageLayoutProps.children

        -

        Defined in node_modules/@types/react/index.d.ts:1348

        +

        Defined in node_modules/@types/react/index.d.ts:1350


        Optional className#

        className? : string

        -

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

        +

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


        Optional customRowHeights#

        customRowHeights? : function

        -

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

        +

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

        Type declaration:

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

        Parameters:

        @@ -2355,7 +2355,7 @@

        Optional dangerouslySetInnerHTML#

        dangerouslySetInnerHTML? : object

        Inherited from PageLayoutProps.dangerouslySetInnerHTML

        -

        Defined in node_modules/@types/react/index.d.ts:1349

        +

        Defined in node_modules/@types/react/index.d.ts:1351

        Type declaration:

        • __html: string
        • @@ -2363,7 +2363,7 @@

          Optional getTableRow#

          getTableRow? : function

          -

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

          +

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

          Type declaration:

          ▸ (uid: string): ReactElement‹TableRowProps

          Parameters:

          @@ -2384,695 +2384,695 @@

          Optional items#

          items? : ItemObject[]

          -

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

          +

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


          Optional noItems#

          noItems? : React.ReactNode

          -

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

          +

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


          Optional onAbort#

          onAbort? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAbort

          -

          Defined in node_modules/@types/react/index.d.ts:1404

          +

          Defined in node_modules/@types/react/index.d.ts:1406


          Optional onAbortCapture#

          onAbortCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAbortCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1405

          +

          Defined in node_modules/@types/react/index.d.ts:1407


          Optional onAnimationEnd#

          onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1534

          +

          Defined in node_modules/@types/react/index.d.ts:1536


          Optional onAnimationEndCapture#

          onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1535

          +

          Defined in node_modules/@types/react/index.d.ts:1537


          Optional onAnimationIteration#

          onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationIteration

          -

          Defined in node_modules/@types/react/index.d.ts:1536

          +

          Defined in node_modules/@types/react/index.d.ts:1538


          Optional onAnimationIterationCapture#

          onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationIterationCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1537

          +

          Defined in node_modules/@types/react/index.d.ts:1539


          Optional onAnimationStart#

          onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationStart

          -

          Defined in node_modules/@types/react/index.d.ts:1532

          +

          Defined in node_modules/@types/react/index.d.ts:1534


          Optional onAnimationStartCapture#

          onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAnimationStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1533

          +

          Defined in node_modules/@types/react/index.d.ts:1535


          Optional onAuxClick#

          onAuxClick? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAuxClick

          -

          Defined in node_modules/@types/react/index.d.ts:1450

          +

          Defined in node_modules/@types/react/index.d.ts:1452


          Optional onAuxClickCapture#

          onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onAuxClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1451

          +

          Defined in node_modules/@types/react/index.d.ts:1453


          Optional onBeforeInput#

          onBeforeInput? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onBeforeInput

          -

          Defined in node_modules/@types/react/index.d.ts:1378

          +

          Defined in node_modules/@types/react/index.d.ts:1380


          Optional onBeforeInputCapture#

          onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onBeforeInputCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1379

          +

          Defined in node_modules/@types/react/index.d.ts:1381


          Optional onBlur#

          onBlur? : FocusEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onBlur

          -

          Defined in node_modules/@types/react/index.d.ts:1372

          +

          Defined in node_modules/@types/react/index.d.ts:1374


          Optional onBlurCapture#

          onBlurCapture? : FocusEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onBlurCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1373

          +

          Defined in node_modules/@types/react/index.d.ts:1375


          Optional onCanPlay#

          onCanPlay? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCanPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1406

          +

          Defined in node_modules/@types/react/index.d.ts:1408


          Optional onCanPlayCapture#

          onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCanPlayCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1407

          +

          Defined in node_modules/@types/react/index.d.ts:1409


          Optional onCanPlayThrough#

          onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCanPlayThrough

          -

          Defined in node_modules/@types/react/index.d.ts:1408

          +

          Defined in node_modules/@types/react/index.d.ts:1410


          Optional onCanPlayThroughCapture#

          onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCanPlayThroughCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1409

          +

          Defined in node_modules/@types/react/index.d.ts:1411


          Optional onChange#

          onChange? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onChange

          -

          Defined in node_modules/@types/react/index.d.ts:1376

          +

          Defined in node_modules/@types/react/index.d.ts:1378


          Optional onChangeCapture#

          onChangeCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1377

          +

          Defined in node_modules/@types/react/index.d.ts:1379


          Optional onClick#

          onClick? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onClick

          -

          Defined in node_modules/@types/react/index.d.ts:1452

          +

          Defined in node_modules/@types/react/index.d.ts:1454


          Optional onClickCapture#

          onClickCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1453

          +

          Defined in node_modules/@types/react/index.d.ts:1455


          Optional onCompositionEnd#

          onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1362

          +

          Defined in node_modules/@types/react/index.d.ts:1364


          Optional onCompositionEndCapture#

          onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1363

          +

          Defined in node_modules/@types/react/index.d.ts:1365


          Optional onCompositionStart#

          onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionStart

          -

          Defined in node_modules/@types/react/index.d.ts:1364

          +

          Defined in node_modules/@types/react/index.d.ts:1366


          Optional onCompositionStartCapture#

          onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1365

          +

          Defined in node_modules/@types/react/index.d.ts:1367


          Optional onCompositionUpdate#

          onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionUpdate

          -

          Defined in node_modules/@types/react/index.d.ts:1366

          +

          Defined in node_modules/@types/react/index.d.ts:1368


          Optional onCompositionUpdateCapture#

          onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCompositionUpdateCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1367

          +

          Defined in node_modules/@types/react/index.d.ts:1369


          Optional onContextMenu#

          onContextMenu? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onContextMenu

          -

          Defined in node_modules/@types/react/index.d.ts:1454

          +

          Defined in node_modules/@types/react/index.d.ts:1456


          Optional onContextMenuCapture#

          onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onContextMenuCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1455

          +

          Defined in node_modules/@types/react/index.d.ts:1457


          Optional onCopy#

          onCopy? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCopy

          -

          Defined in node_modules/@types/react/index.d.ts:1354

          +

          Defined in node_modules/@types/react/index.d.ts:1356


          Optional onCopyCapture#

          onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCopyCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1355

          +

          Defined in node_modules/@types/react/index.d.ts:1357


          Optional onCut#

          onCut? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCut

          -

          Defined in node_modules/@types/react/index.d.ts:1356

          +

          Defined in node_modules/@types/react/index.d.ts:1358


          Optional onCutCapture#

          onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onCutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1357

          +

          Defined in node_modules/@types/react/index.d.ts:1359


          Optional onDoubleClick#

          onDoubleClick? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDoubleClick

          -

          Defined in node_modules/@types/react/index.d.ts:1456

          +

          Defined in node_modules/@types/react/index.d.ts:1458


          Optional onDoubleClickCapture#

          onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDoubleClickCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1457

          +

          Defined in node_modules/@types/react/index.d.ts:1459


          Optional onDrag#

          onDrag? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDrag

          -

          Defined in node_modules/@types/react/index.d.ts:1458

          +

          Defined in node_modules/@types/react/index.d.ts:1460


          Optional onDragCapture#

          onDragCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1459

          +

          Defined in node_modules/@types/react/index.d.ts:1461


          Optional onDragEnd#

          onDragEnd? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1460

          +

          Defined in node_modules/@types/react/index.d.ts:1462


          Optional onDragEndCapture#

          onDragEndCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1461

          +

          Defined in node_modules/@types/react/index.d.ts:1463


          Optional onDragEnter#

          onDragEnter? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1462

          +

          Defined in node_modules/@types/react/index.d.ts:1464


          Optional onDragEnterCapture#

          onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragEnterCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1463

          +

          Defined in node_modules/@types/react/index.d.ts:1465


          Optional onDragExit#

          onDragExit? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragExit

          -

          Defined in node_modules/@types/react/index.d.ts:1464

          +

          Defined in node_modules/@types/react/index.d.ts:1466


          Optional onDragExitCapture#

          onDragExitCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragExitCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1465

          +

          Defined in node_modules/@types/react/index.d.ts:1467


          Optional onDragLeave#

          onDragLeave? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1466

          +

          Defined in node_modules/@types/react/index.d.ts:1468


          Optional onDragLeaveCapture#

          onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragLeaveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1467

          +

          Defined in node_modules/@types/react/index.d.ts:1469


          Optional onDragOver#

          onDragOver? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragOver

          -

          Defined in node_modules/@types/react/index.d.ts:1468

          +

          Defined in node_modules/@types/react/index.d.ts:1470


          Optional onDragOverCapture#

          onDragOverCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1469

          +

          Defined in node_modules/@types/react/index.d.ts:1471


          Optional onDragStart#

          onDragStart? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragStart

          -

          Defined in node_modules/@types/react/index.d.ts:1470

          +

          Defined in node_modules/@types/react/index.d.ts:1472


          Optional onDragStartCapture#

          onDragStartCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDragStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1471

          +

          Defined in node_modules/@types/react/index.d.ts:1473


          Optional onDrop#

          onDrop? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDrop

          -

          Defined in node_modules/@types/react/index.d.ts:1472

          +

          Defined in node_modules/@types/react/index.d.ts:1474


          Optional onDropCapture#

          onDropCapture? : DragEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDropCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1473

          +

          Defined in node_modules/@types/react/index.d.ts:1475


          Optional onDurationChange#

          onDurationChange? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDurationChange

          -

          Defined in node_modules/@types/react/index.d.ts:1410

          +

          Defined in node_modules/@types/react/index.d.ts:1412


          Optional onDurationChangeCapture#

          onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onDurationChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1411

          +

          Defined in node_modules/@types/react/index.d.ts:1413


          Optional onEmptied#

          onEmptied? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEmptied

          -

          Defined in node_modules/@types/react/index.d.ts:1412

          +

          Defined in node_modules/@types/react/index.d.ts:1414


          Optional onEmptiedCapture#

          onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEmptiedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1413

          +

          Defined in node_modules/@types/react/index.d.ts:1415


          Optional onEncrypted#

          onEncrypted? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEncrypted

          -

          Defined in node_modules/@types/react/index.d.ts:1414

          +

          Defined in node_modules/@types/react/index.d.ts:1416


          Optional onEncryptedCapture#

          onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEncryptedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1415

          +

          Defined in node_modules/@types/react/index.d.ts:1417


          Optional onEnded#

          onEnded? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEnded

          -

          Defined in node_modules/@types/react/index.d.ts:1416

          +

          Defined in node_modules/@types/react/index.d.ts:1418


          Optional onEndedCapture#

          onEndedCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onEndedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1417

          +

          Defined in node_modules/@types/react/index.d.ts:1419


          Optional onError#

          onError? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onError

          -

          Defined in node_modules/@types/react/index.d.ts:1392

          +

          Defined in node_modules/@types/react/index.d.ts:1394


          Optional onErrorCapture#

          onErrorCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onErrorCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1393

          +

          Defined in node_modules/@types/react/index.d.ts:1395


          Optional onFocus#

          onFocus? : FocusEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onFocus

          -

          Defined in node_modules/@types/react/index.d.ts:1370

          +

          Defined in node_modules/@types/react/index.d.ts:1372


          Optional onFocusCapture#

          onFocusCapture? : FocusEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onFocusCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1371

          +

          Defined in node_modules/@types/react/index.d.ts:1373


          Optional onGotPointerCapture#

          onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onGotPointerCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1518

          +

          Defined in node_modules/@types/react/index.d.ts:1520


          Optional onGotPointerCaptureCapture#

          onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onGotPointerCaptureCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1519

          +

          Defined in node_modules/@types/react/index.d.ts:1521


          Optional onInput#

          onInput? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onInput

          -

          Defined in node_modules/@types/react/index.d.ts:1380

          +

          Defined in node_modules/@types/react/index.d.ts:1382


          Optional onInputCapture#

          onInputCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onInputCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1381

          +

          Defined in node_modules/@types/react/index.d.ts:1383


          Optional onInvalid#

          onInvalid? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onInvalid

          -

          Defined in node_modules/@types/react/index.d.ts:1386

          +

          Defined in node_modules/@types/react/index.d.ts:1388


          Optional onInvalidCapture#

          onInvalidCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onInvalidCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1387

          +

          Defined in node_modules/@types/react/index.d.ts:1389


          Optional onKeyDown#

          onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyDown

          -

          Defined in node_modules/@types/react/index.d.ts:1396

          +

          Defined in node_modules/@types/react/index.d.ts:1398


          Optional onKeyDownCapture#

          onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1397

          +

          Defined in node_modules/@types/react/index.d.ts:1399


          Optional onKeyPress#

          onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyPress

          -

          Defined in node_modules/@types/react/index.d.ts:1398

          +

          Defined in node_modules/@types/react/index.d.ts:1400


          Optional onKeyPressCapture#

          onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyPressCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1399

          +

          Defined in node_modules/@types/react/index.d.ts:1401


          Optional onKeyUp#

          onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyUp

          -

          Defined in node_modules/@types/react/index.d.ts:1400

          +

          Defined in node_modules/@types/react/index.d.ts:1402


          Optional onKeyUpCapture#

          onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onKeyUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1401

          +

          Defined in node_modules/@types/react/index.d.ts:1403


          Optional onLoad#

          onLoad? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoad

          -

          Defined in node_modules/@types/react/index.d.ts:1390

          +

          Defined in node_modules/@types/react/index.d.ts:1392


          Optional onLoadCapture#

          onLoadCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1391

          +

          Defined in node_modules/@types/react/index.d.ts:1393


          Optional onLoadStart#

          onLoadStart? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadStart

          -

          Defined in node_modules/@types/react/index.d.ts:1422

          +

          Defined in node_modules/@types/react/index.d.ts:1424


          Optional onLoadStartCapture#

          onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1423

          +

          Defined in node_modules/@types/react/index.d.ts:1425


          Optional onLoadedData#

          onLoadedData? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadedData

          -

          Defined in node_modules/@types/react/index.d.ts:1418

          +

          Defined in node_modules/@types/react/index.d.ts:1420


          Optional onLoadedDataCapture#

          onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadedDataCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1419

          +

          Defined in node_modules/@types/react/index.d.ts:1421


          Optional onLoadedMetadata#

          onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadedMetadata

          -

          Defined in node_modules/@types/react/index.d.ts:1420

          +

          Defined in node_modules/@types/react/index.d.ts:1422


          Optional onLoadedMetadataCapture#

          onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLoadedMetadataCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1421

          +

          Defined in node_modules/@types/react/index.d.ts:1423


          Optional onLostPointerCapture#

          onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLostPointerCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1520

          +

          Defined in node_modules/@types/react/index.d.ts:1522


          Optional onLostPointerCaptureCapture#

          onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onLostPointerCaptureCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1521

          +

          Defined in node_modules/@types/react/index.d.ts:1523


          Optional onMouseDown#

          onMouseDown? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseDown

          -

          Defined in node_modules/@types/react/index.d.ts:1474

          +

          Defined in node_modules/@types/react/index.d.ts:1476


          Optional onMouseDownCapture#

          onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1475

          +

          Defined in node_modules/@types/react/index.d.ts:1477


          Optional onMouseEnter#

          onMouseEnter? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1476

          +

          Defined in node_modules/@types/react/index.d.ts:1478


          Optional onMouseLeave#

          onMouseLeave? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1477

          +

          Defined in node_modules/@types/react/index.d.ts:1479


          Optional onMouseMove#

          onMouseMove? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseMove

          -

          Defined in node_modules/@types/react/index.d.ts:1478

          +

          Defined in node_modules/@types/react/index.d.ts:1480


          Optional onMouseMoveCapture#

          onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1479

          +

          Defined in node_modules/@types/react/index.d.ts:1481


          Optional onMouseOut#

          onMouseOut? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseOut

          -

          Defined in node_modules/@types/react/index.d.ts:1480

          +

          Defined in node_modules/@types/react/index.d.ts:1482


          Optional onMouseOutCapture#

          onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseOutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1481

          +

          Defined in node_modules/@types/react/index.d.ts:1483


          Optional onMouseOver#

          onMouseOver? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseOver

          -

          Defined in node_modules/@types/react/index.d.ts:1482

          +

          Defined in node_modules/@types/react/index.d.ts:1484


          Optional onMouseOverCapture#

          onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1483

          +

          Defined in node_modules/@types/react/index.d.ts:1485


          Optional onMouseUp#

          onMouseUp? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseUp

          -

          Defined in node_modules/@types/react/index.d.ts:1484

          +

          Defined in node_modules/@types/react/index.d.ts:1486


          Optional onMouseUpCapture#

          onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onMouseUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1485

          +

          Defined in node_modules/@types/react/index.d.ts:1487


          Optional onPaste#

          onPaste? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPaste

          -

          Defined in node_modules/@types/react/index.d.ts:1358

          +

          Defined in node_modules/@types/react/index.d.ts:1360


          Optional onPasteCapture#

          onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPasteCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1359

          +

          Defined in node_modules/@types/react/index.d.ts:1361


          Optional onPause#

          onPause? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPause

          -

          Defined in node_modules/@types/react/index.d.ts:1424

          +

          Defined in node_modules/@types/react/index.d.ts:1426


          Optional onPauseCapture#

          onPauseCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPauseCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1425

          +

          Defined in node_modules/@types/react/index.d.ts:1427


          Optional onPlay#

          onPlay? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPlay

          -

          Defined in node_modules/@types/react/index.d.ts:1426

          +

          Defined in node_modules/@types/react/index.d.ts:1428


          Optional onPlayCapture#

          onPlayCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPlayCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1427

          +

          Defined in node_modules/@types/react/index.d.ts:1429


          Optional onPlaying#

          onPlaying? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPlaying

          -

          Defined in node_modules/@types/react/index.d.ts:1428

          +

          Defined in node_modules/@types/react/index.d.ts:1430


          Optional onPlayingCapture#

          onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPlayingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1429

          +

          Defined in node_modules/@types/react/index.d.ts:1431


          Optional onPointerCancel#

          onPointerCancel? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerCancel

          -

          Defined in node_modules/@types/react/index.d.ts:1508

          +

          Defined in node_modules/@types/react/index.d.ts:1510


          Optional onPointerCancelCapture#

          onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerCancelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1509

          +

          Defined in node_modules/@types/react/index.d.ts:1511


          Optional onPointerDown#

          onPointerDown? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerDown

          -

          Defined in node_modules/@types/react/index.d.ts:1502

          +

          Defined in node_modules/@types/react/index.d.ts:1504


          Optional onPointerDownCapture#

          onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerDownCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1503

          +

          Defined in node_modules/@types/react/index.d.ts:1505


          Optional onPointerEnter#

          onPointerEnter? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerEnter

          -

          Defined in node_modules/@types/react/index.d.ts:1510

          +

          Defined in node_modules/@types/react/index.d.ts:1512


          Optional onPointerEnterCapture#

          onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerEnterCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1511

          +

          Defined in node_modules/@types/react/index.d.ts:1513


          Optional onPointerLeave#

          onPointerLeave? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerLeave

          -

          Defined in node_modules/@types/react/index.d.ts:1512

          +

          Defined in node_modules/@types/react/index.d.ts:1514


          Optional onPointerLeaveCapture#

          onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerLeaveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1513

          +

          Defined in node_modules/@types/react/index.d.ts:1515


          Optional onPointerMove#

          onPointerMove? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerMove

          -

          Defined in node_modules/@types/react/index.d.ts:1504

          +

          Defined in node_modules/@types/react/index.d.ts:1506


          Optional onPointerMoveCapture#

          onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1505

          +

          Defined in node_modules/@types/react/index.d.ts:1507


          Optional onPointerOut#

          onPointerOut? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerOut

          -

          Defined in node_modules/@types/react/index.d.ts:1516

          +

          Defined in node_modules/@types/react/index.d.ts:1518


          Optional onPointerOutCapture#

          onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerOutCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1517

          +

          Defined in node_modules/@types/react/index.d.ts:1519


          Optional onPointerOver#

          onPointerOver? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerOver

          -

          Defined in node_modules/@types/react/index.d.ts:1514

          +

          Defined in node_modules/@types/react/index.d.ts:1516


          Optional onPointerOverCapture#

          onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerOverCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1515

          +

          Defined in node_modules/@types/react/index.d.ts:1517


          Optional onPointerUp#

          onPointerUp? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerUp

          -

          Defined in node_modules/@types/react/index.d.ts:1506

          +

          Defined in node_modules/@types/react/index.d.ts:1508


          Optional onPointerUpCapture#

          onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onPointerUpCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1507

          +

          Defined in node_modules/@types/react/index.d.ts:1509


          Optional onProgress#

          onProgress? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onProgress

          -

          Defined in node_modules/@types/react/index.d.ts:1430

          +

          Defined in node_modules/@types/react/index.d.ts:1432


          Optional onProgressCapture#

          onProgressCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onProgressCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1431

          +

          Defined in node_modules/@types/react/index.d.ts:1433


          Optional onRateChange#

          onRateChange? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onRateChange

          -

          Defined in node_modules/@types/react/index.d.ts:1432

          +

          Defined in node_modules/@types/react/index.d.ts:1434


          Optional onRateChangeCapture#

          onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onRateChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1433

          +

          Defined in node_modules/@types/react/index.d.ts:1435


          Optional onReset#

          onReset? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onReset

          -

          Defined in node_modules/@types/react/index.d.ts:1382

          +

          Defined in node_modules/@types/react/index.d.ts:1384


          Optional onResetCapture#

          onResetCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onResetCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1383

          +

          Defined in node_modules/@types/react/index.d.ts:1385


          Optional onScroll#

          onScroll? : UIEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onScroll

          -

          Defined in node_modules/@types/react/index.d.ts:1524

          +

          Defined in node_modules/@types/react/index.d.ts:1526


          Optional onScrollCapture#

          onScrollCapture? : UIEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onScrollCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1525

          +

          Defined in node_modules/@types/react/index.d.ts:1527


          Optional onSeeked#

          onSeeked? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSeeked

          -

          Defined in node_modules/@types/react/index.d.ts:1434

          +

          Defined in node_modules/@types/react/index.d.ts:1436


          Optional onSeekedCapture#

          onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSeekedCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1435

          +

          Defined in node_modules/@types/react/index.d.ts:1437


          Optional onSeeking#

          onSeeking? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSeeking

          -

          Defined in node_modules/@types/react/index.d.ts:1436

          +

          Defined in node_modules/@types/react/index.d.ts:1438


          Optional onSeekingCapture#

          onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSeekingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1437

          +

          Defined in node_modules/@types/react/index.d.ts:1439


          Optional onSelect#

          onSelect? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSelect

          -

          Defined in node_modules/@types/react/index.d.ts:1488

          +

          Defined in node_modules/@types/react/index.d.ts:1490


          Optional onSelectCapture#

          onSelectCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSelectCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1489

          +

          Defined in node_modules/@types/react/index.d.ts:1491


          Optional onSort#

          onSort? : function

          -

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

          +

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

          Type declaration:

          ▸ (params: TableSortParams): void

          Parameters:

          @@ -3094,154 +3094,154 @@

          Optional onStalled#

          onStalled? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onStalled

          -

          Defined in node_modules/@types/react/index.d.ts:1438

          +

          Defined in node_modules/@types/react/index.d.ts:1440


          Optional onStalledCapture#

          onStalledCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onStalledCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1439

          +

          Defined in node_modules/@types/react/index.d.ts:1441


          Optional onSubmit#

          onSubmit? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSubmit

          -

          Defined in node_modules/@types/react/index.d.ts:1384

          +

          Defined in node_modules/@types/react/index.d.ts:1386


          Optional onSubmitCapture#

          onSubmitCapture? : FormEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSubmitCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1385

          +

          Defined in node_modules/@types/react/index.d.ts:1387


          Optional onSuspend#

          onSuspend? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSuspend

          -

          Defined in node_modules/@types/react/index.d.ts:1440

          +

          Defined in node_modules/@types/react/index.d.ts:1442


          Optional onSuspendCapture#

          onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onSuspendCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1441

          +

          Defined in node_modules/@types/react/index.d.ts:1443


          Optional onTimeUpdate#

          onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTimeUpdate

          -

          Defined in node_modules/@types/react/index.d.ts:1442

          +

          Defined in node_modules/@types/react/index.d.ts:1444


          Optional onTimeUpdateCapture#

          onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTimeUpdateCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1443

          +

          Defined in node_modules/@types/react/index.d.ts:1445


          Optional onTouchCancel#

          onTouchCancel? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchCancel

          -

          Defined in node_modules/@types/react/index.d.ts:1492

          +

          Defined in node_modules/@types/react/index.d.ts:1494


          Optional onTouchCancelCapture#

          onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchCancelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1493

          +

          Defined in node_modules/@types/react/index.d.ts:1495


          Optional onTouchEnd#

          onTouchEnd? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1494

          +

          Defined in node_modules/@types/react/index.d.ts:1496


          Optional onTouchEndCapture#

          onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1495

          +

          Defined in node_modules/@types/react/index.d.ts:1497


          Optional onTouchMove#

          onTouchMove? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchMove

          -

          Defined in node_modules/@types/react/index.d.ts:1496

          +

          Defined in node_modules/@types/react/index.d.ts:1498


          Optional onTouchMoveCapture#

          onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchMoveCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1497

          +

          Defined in node_modules/@types/react/index.d.ts:1499


          Optional onTouchStart#

          onTouchStart? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchStart

          -

          Defined in node_modules/@types/react/index.d.ts:1498

          +

          Defined in node_modules/@types/react/index.d.ts:1500


          Optional onTouchStartCapture#

          onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTouchStartCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1499

          +

          Defined in node_modules/@types/react/index.d.ts:1501


          Optional onTransitionEnd#

          onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTransitionEnd

          -

          Defined in node_modules/@types/react/index.d.ts:1540

          +

          Defined in node_modules/@types/react/index.d.ts:1542


          Optional onTransitionEndCapture#

          onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onTransitionEndCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1541

          +

          Defined in node_modules/@types/react/index.d.ts:1543


          Optional onVolumeChange#

          onVolumeChange? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onVolumeChange

          -

          Defined in node_modules/@types/react/index.d.ts:1444

          +

          Defined in node_modules/@types/react/index.d.ts:1446


          Optional onVolumeChangeCapture#

          onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onVolumeChangeCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1445

          +

          Defined in node_modules/@types/react/index.d.ts:1447


          Optional onWaiting#

          onWaiting? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onWaiting

          -

          Defined in node_modules/@types/react/index.d.ts:1446

          +

          Defined in node_modules/@types/react/index.d.ts:1448


          Optional onWaitingCapture#

          onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onWaitingCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1447

          +

          Defined in node_modules/@types/react/index.d.ts:1449


          Optional onWheel#

          onWheel? : WheelEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onWheel

          -

          Defined in node_modules/@types/react/index.d.ts:1528

          +

          Defined in node_modules/@types/react/index.d.ts:1530


          Optional onWheelCapture#

          onWheelCapture? : WheelEventHandler‹HTMLDivElement›

          Inherited from PageLayoutProps.onWheelCapture

          -

          Defined in node_modules/@types/react/index.d.ts:1529

          +

          Defined in node_modules/@types/react/index.d.ts:1531


          Optional rowLineHeight#

          rowLineHeight? : string

          -

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

          +

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


          Optional rowPadding#

          rowPadding? : string

          -

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

          +

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


          Optional scrollable#

          scrollable? : boolean

          -

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

          +

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


          Optional selectable#

          selectable? : boolean

          -

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

          +

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


          Optional selectedItemId#

          selectedItemId? : string

          -

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

          +

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


          Optional sortByDefault#

          sortByDefault? : Partial‹TableSortParams

          -

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

          +

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


          Optional sortSyncWithUrl#

          sortSyncWithUrl? : boolean

          -

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

          +

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


          Optional sortable#

          sortable? : object

          -

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

          +

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

          Type declaration:

          • [ sortBy: string]: TableSortCallback
          • @@ -3249,11 +3249,11 @@

            Optional storageKey#

            storageKey? : string

            -

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

            +

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


            Optional virtual#

            virtual? : boolean

            -

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

            +

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

            diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html index bb28dbee9e..518313b61b 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • @@ -2233,16 +2233,16 @@

            Optional children#

            children? : ReactNode

            Inherited from PageLayoutProps.children

            -

            Defined in node_modules/@types/react/index.d.ts:1348

            +

            Defined in node_modules/@types/react/index.d.ts:1350


            Optional className#

            className? : string

            -

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

            +

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


            Optional dangerouslySetInnerHTML#

            dangerouslySetInnerHTML? : object

            Inherited from PageLayoutProps.dangerouslySetInnerHTML

            -

            Defined in node_modules/@types/react/index.d.ts:1349

            +

            Defined in node_modules/@types/react/index.d.ts:1351

            Type declaration:

            • __html: string
            • @@ -2250,827 +2250,827 @@

              Optional disabled#

              disabled? : boolean

              -

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

              +

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


              Optional nowrap#

              nowrap? : boolean

              -

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

              +

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


              Optional onAbort#

              onAbort? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAbort

              -

              Defined in node_modules/@types/react/index.d.ts:1404

              +

              Defined in node_modules/@types/react/index.d.ts:1406


              Optional onAbortCapture#

              onAbortCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAbortCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1405

              +

              Defined in node_modules/@types/react/index.d.ts:1407


              Optional onAnimationEnd#

              onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAnimationEnd

              -

              Defined in node_modules/@types/react/index.d.ts:1534

              +

              Defined in node_modules/@types/react/index.d.ts:1536


              Optional onAnimationEndCapture#

              onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAnimationEndCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1535

              +

              Defined in node_modules/@types/react/index.d.ts:1537


              Optional onAnimationIteration#

              onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAnimationIteration

              -

              Defined in node_modules/@types/react/index.d.ts:1536

              +

              Defined in node_modules/@types/react/index.d.ts:1538


              Optional onAnimationIterationCapture#

              onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAnimationIterationCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1537

              +

              Defined in node_modules/@types/react/index.d.ts:1539


              Optional onAnimationStart#

              onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAnimationStart

              -

              Defined in node_modules/@types/react/index.d.ts:1532

              +

              Defined in node_modules/@types/react/index.d.ts:1534


              Optional onAnimationStartCapture#

              onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAnimationStartCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1533

              +

              Defined in node_modules/@types/react/index.d.ts:1535


              Optional onAuxClick#

              onAuxClick? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAuxClick

              -

              Defined in node_modules/@types/react/index.d.ts:1450

              +

              Defined in node_modules/@types/react/index.d.ts:1452


              Optional onAuxClickCapture#

              onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onAuxClickCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1451

              +

              Defined in node_modules/@types/react/index.d.ts:1453


              Optional onBeforeInput#

              onBeforeInput? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onBeforeInput

              -

              Defined in node_modules/@types/react/index.d.ts:1378

              +

              Defined in node_modules/@types/react/index.d.ts:1380


              Optional onBeforeInputCapture#

              onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onBeforeInputCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1379

              +

              Defined in node_modules/@types/react/index.d.ts:1381


              Optional onBlur#

              onBlur? : FocusEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onBlur

              -

              Defined in node_modules/@types/react/index.d.ts:1372

              +

              Defined in node_modules/@types/react/index.d.ts:1374


              Optional onBlurCapture#

              onBlurCapture? : FocusEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onBlurCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1373

              +

              Defined in node_modules/@types/react/index.d.ts:1375


              Optional onCanPlay#

              onCanPlay? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCanPlay

              -

              Defined in node_modules/@types/react/index.d.ts:1406

              +

              Defined in node_modules/@types/react/index.d.ts:1408


              Optional onCanPlayCapture#

              onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCanPlayCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1407

              +

              Defined in node_modules/@types/react/index.d.ts:1409


              Optional onCanPlayThrough#

              onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCanPlayThrough

              -

              Defined in node_modules/@types/react/index.d.ts:1408

              +

              Defined in node_modules/@types/react/index.d.ts:1410


              Optional onCanPlayThroughCapture#

              onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCanPlayThroughCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1409

              +

              Defined in node_modules/@types/react/index.d.ts:1411


              Optional onChange#

              onChange? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onChange

              -

              Defined in node_modules/@types/react/index.d.ts:1376

              +

              Defined in node_modules/@types/react/index.d.ts:1378


              Optional onChangeCapture#

              onChangeCapture? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onChangeCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1377

              +

              Defined in node_modules/@types/react/index.d.ts:1379


              Optional onClick#

              onClick? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onClick

              -

              Defined in node_modules/@types/react/index.d.ts:1452

              +

              Defined in node_modules/@types/react/index.d.ts:1454


              Optional onClickCapture#

              onClickCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onClickCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1453

              +

              Defined in node_modules/@types/react/index.d.ts:1455


              Optional onCompositionEnd#

              onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCompositionEnd

              -

              Defined in node_modules/@types/react/index.d.ts:1362

              +

              Defined in node_modules/@types/react/index.d.ts:1364


              Optional onCompositionEndCapture#

              onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCompositionEndCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1363

              +

              Defined in node_modules/@types/react/index.d.ts:1365


              Optional onCompositionStart#

              onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCompositionStart

              -

              Defined in node_modules/@types/react/index.d.ts:1364

              +

              Defined in node_modules/@types/react/index.d.ts:1366


              Optional onCompositionStartCapture#

              onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCompositionStartCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1365

              +

              Defined in node_modules/@types/react/index.d.ts:1367


              Optional onCompositionUpdate#

              onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCompositionUpdate

              -

              Defined in node_modules/@types/react/index.d.ts:1366

              +

              Defined in node_modules/@types/react/index.d.ts:1368


              Optional onCompositionUpdateCapture#

              onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCompositionUpdateCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1367

              +

              Defined in node_modules/@types/react/index.d.ts:1369


              Optional onContextMenu#

              onContextMenu? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onContextMenu

              -

              Defined in node_modules/@types/react/index.d.ts:1454

              +

              Defined in node_modules/@types/react/index.d.ts:1456


              Optional onContextMenuCapture#

              onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onContextMenuCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1455

              +

              Defined in node_modules/@types/react/index.d.ts:1457


              Optional onCopy#

              onCopy? : ClipboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCopy

              -

              Defined in node_modules/@types/react/index.d.ts:1354

              +

              Defined in node_modules/@types/react/index.d.ts:1356


              Optional onCopyCapture#

              onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCopyCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1355

              +

              Defined in node_modules/@types/react/index.d.ts:1357


              Optional onCut#

              onCut? : ClipboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCut

              -

              Defined in node_modules/@types/react/index.d.ts:1356

              +

              Defined in node_modules/@types/react/index.d.ts:1358


              Optional onCutCapture#

              onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onCutCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1357

              +

              Defined in node_modules/@types/react/index.d.ts:1359


              Optional onDoubleClick#

              onDoubleClick? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDoubleClick

              -

              Defined in node_modules/@types/react/index.d.ts:1456

              +

              Defined in node_modules/@types/react/index.d.ts:1458


              Optional onDoubleClickCapture#

              onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDoubleClickCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1457

              +

              Defined in node_modules/@types/react/index.d.ts:1459


              Optional onDrag#

              onDrag? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDrag

              -

              Defined in node_modules/@types/react/index.d.ts:1458

              +

              Defined in node_modules/@types/react/index.d.ts:1460


              Optional onDragCapture#

              onDragCapture? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1459

              +

              Defined in node_modules/@types/react/index.d.ts:1461


              Optional onDragEnd#

              onDragEnd? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragEnd

              -

              Defined in node_modules/@types/react/index.d.ts:1460

              +

              Defined in node_modules/@types/react/index.d.ts:1462


              Optional onDragEndCapture#

              onDragEndCapture? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragEndCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1461

              +

              Defined in node_modules/@types/react/index.d.ts:1463


              Optional onDragEnter#

              onDragEnter? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragEnter

              -

              Defined in node_modules/@types/react/index.d.ts:1462

              +

              Defined in node_modules/@types/react/index.d.ts:1464


              Optional onDragEnterCapture#

              onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragEnterCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1463

              +

              Defined in node_modules/@types/react/index.d.ts:1465


              Optional onDragExit#

              onDragExit? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragExit

              -

              Defined in node_modules/@types/react/index.d.ts:1464

              +

              Defined in node_modules/@types/react/index.d.ts:1466


              Optional onDragExitCapture#

              onDragExitCapture? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragExitCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1465

              +

              Defined in node_modules/@types/react/index.d.ts:1467


              Optional onDragLeave#

              onDragLeave? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragLeave

              -

              Defined in node_modules/@types/react/index.d.ts:1466

              +

              Defined in node_modules/@types/react/index.d.ts:1468


              Optional onDragLeaveCapture#

              onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragLeaveCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1467

              +

              Defined in node_modules/@types/react/index.d.ts:1469


              Optional onDragOver#

              onDragOver? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragOver

              -

              Defined in node_modules/@types/react/index.d.ts:1468

              +

              Defined in node_modules/@types/react/index.d.ts:1470


              Optional onDragOverCapture#

              onDragOverCapture? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragOverCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1469

              +

              Defined in node_modules/@types/react/index.d.ts:1471


              Optional onDragStart#

              onDragStart? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragStart

              -

              Defined in node_modules/@types/react/index.d.ts:1470

              +

              Defined in node_modules/@types/react/index.d.ts:1472


              Optional onDragStartCapture#

              onDragStartCapture? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDragStartCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1471

              +

              Defined in node_modules/@types/react/index.d.ts:1473


              Optional onDrop#

              onDrop? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDrop

              -

              Defined in node_modules/@types/react/index.d.ts:1472

              +

              Defined in node_modules/@types/react/index.d.ts:1474


              Optional onDropCapture#

              onDropCapture? : DragEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDropCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1473

              +

              Defined in node_modules/@types/react/index.d.ts:1475


              Optional onDurationChange#

              onDurationChange? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDurationChange

              -

              Defined in node_modules/@types/react/index.d.ts:1410

              +

              Defined in node_modules/@types/react/index.d.ts:1412


              Optional onDurationChangeCapture#

              onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onDurationChangeCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1411

              +

              Defined in node_modules/@types/react/index.d.ts:1413


              Optional onEmptied#

              onEmptied? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onEmptied

              -

              Defined in node_modules/@types/react/index.d.ts:1412

              +

              Defined in node_modules/@types/react/index.d.ts:1414


              Optional onEmptiedCapture#

              onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onEmptiedCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1413

              +

              Defined in node_modules/@types/react/index.d.ts:1415


              Optional onEncrypted#

              onEncrypted? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onEncrypted

              -

              Defined in node_modules/@types/react/index.d.ts:1414

              +

              Defined in node_modules/@types/react/index.d.ts:1416


              Optional onEncryptedCapture#

              onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onEncryptedCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1415

              +

              Defined in node_modules/@types/react/index.d.ts:1417


              Optional onEnded#

              onEnded? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onEnded

              -

              Defined in node_modules/@types/react/index.d.ts:1416

              +

              Defined in node_modules/@types/react/index.d.ts:1418


              Optional onEndedCapture#

              onEndedCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onEndedCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1417

              +

              Defined in node_modules/@types/react/index.d.ts:1419


              Optional onError#

              onError? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onError

              -

              Defined in node_modules/@types/react/index.d.ts:1392

              +

              Defined in node_modules/@types/react/index.d.ts:1394


              Optional onErrorCapture#

              onErrorCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onErrorCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1393

              +

              Defined in node_modules/@types/react/index.d.ts:1395


              Optional onFocus#

              onFocus? : FocusEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onFocus

              -

              Defined in node_modules/@types/react/index.d.ts:1370

              +

              Defined in node_modules/@types/react/index.d.ts:1372


              Optional onFocusCapture#

              onFocusCapture? : FocusEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onFocusCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1371

              +

              Defined in node_modules/@types/react/index.d.ts:1373


              Optional onGotPointerCapture#

              onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onGotPointerCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1518

              +

              Defined in node_modules/@types/react/index.d.ts:1520


              Optional onGotPointerCaptureCapture#

              onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onGotPointerCaptureCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1519

              +

              Defined in node_modules/@types/react/index.d.ts:1521


              Optional onInput#

              onInput? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onInput

              -

              Defined in node_modules/@types/react/index.d.ts:1380

              +

              Defined in node_modules/@types/react/index.d.ts:1382


              Optional onInputCapture#

              onInputCapture? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onInputCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1381

              +

              Defined in node_modules/@types/react/index.d.ts:1383


              Optional onInvalid#

              onInvalid? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onInvalid

              -

              Defined in node_modules/@types/react/index.d.ts:1386

              +

              Defined in node_modules/@types/react/index.d.ts:1388


              Optional onInvalidCapture#

              onInvalidCapture? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onInvalidCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1387

              +

              Defined in node_modules/@types/react/index.d.ts:1389


              Optional onKeyDown#

              onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onKeyDown

              -

              Defined in node_modules/@types/react/index.d.ts:1396

              +

              Defined in node_modules/@types/react/index.d.ts:1398


              Optional onKeyDownCapture#

              onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onKeyDownCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1397

              +

              Defined in node_modules/@types/react/index.d.ts:1399


              Optional onKeyPress#

              onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onKeyPress

              -

              Defined in node_modules/@types/react/index.d.ts:1398

              +

              Defined in node_modules/@types/react/index.d.ts:1400


              Optional onKeyPressCapture#

              onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onKeyPressCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1399

              +

              Defined in node_modules/@types/react/index.d.ts:1401


              Optional onKeyUp#

              onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onKeyUp

              -

              Defined in node_modules/@types/react/index.d.ts:1400

              +

              Defined in node_modules/@types/react/index.d.ts:1402


              Optional onKeyUpCapture#

              onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onKeyUpCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1401

              +

              Defined in node_modules/@types/react/index.d.ts:1403


              Optional onLoad#

              onLoad? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLoad

              -

              Defined in node_modules/@types/react/index.d.ts:1390

              +

              Defined in node_modules/@types/react/index.d.ts:1392


              Optional onLoadCapture#

              onLoadCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLoadCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1391

              +

              Defined in node_modules/@types/react/index.d.ts:1393


              Optional onLoadStart#

              onLoadStart? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLoadStart

              -

              Defined in node_modules/@types/react/index.d.ts:1422

              +

              Defined in node_modules/@types/react/index.d.ts:1424


              Optional onLoadStartCapture#

              onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLoadStartCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1423

              +

              Defined in node_modules/@types/react/index.d.ts:1425


              Optional onLoadedData#

              onLoadedData? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLoadedData

              -

              Defined in node_modules/@types/react/index.d.ts:1418

              +

              Defined in node_modules/@types/react/index.d.ts:1420


              Optional onLoadedDataCapture#

              onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLoadedDataCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1419

              +

              Defined in node_modules/@types/react/index.d.ts:1421


              Optional onLoadedMetadata#

              onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLoadedMetadata

              -

              Defined in node_modules/@types/react/index.d.ts:1420

              +

              Defined in node_modules/@types/react/index.d.ts:1422


              Optional onLoadedMetadataCapture#

              onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLoadedMetadataCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1421

              +

              Defined in node_modules/@types/react/index.d.ts:1423


              Optional onLostPointerCapture#

              onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLostPointerCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1520

              +

              Defined in node_modules/@types/react/index.d.ts:1522


              Optional onLostPointerCaptureCapture#

              onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onLostPointerCaptureCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1521

              +

              Defined in node_modules/@types/react/index.d.ts:1523


              Optional onMouseDown#

              onMouseDown? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseDown

              -

              Defined in node_modules/@types/react/index.d.ts:1474

              +

              Defined in node_modules/@types/react/index.d.ts:1476


              Optional onMouseDownCapture#

              onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseDownCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1475

              +

              Defined in node_modules/@types/react/index.d.ts:1477


              Optional onMouseEnter#

              onMouseEnter? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseEnter

              -

              Defined in node_modules/@types/react/index.d.ts:1476

              +

              Defined in node_modules/@types/react/index.d.ts:1478


              Optional onMouseLeave#

              onMouseLeave? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseLeave

              -

              Defined in node_modules/@types/react/index.d.ts:1477

              +

              Defined in node_modules/@types/react/index.d.ts:1479


              Optional onMouseMove#

              onMouseMove? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseMove

              -

              Defined in node_modules/@types/react/index.d.ts:1478

              +

              Defined in node_modules/@types/react/index.d.ts:1480


              Optional onMouseMoveCapture#

              onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseMoveCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1479

              +

              Defined in node_modules/@types/react/index.d.ts:1481


              Optional onMouseOut#

              onMouseOut? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseOut

              -

              Defined in node_modules/@types/react/index.d.ts:1480

              +

              Defined in node_modules/@types/react/index.d.ts:1482


              Optional onMouseOutCapture#

              onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseOutCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1481

              +

              Defined in node_modules/@types/react/index.d.ts:1483


              Optional onMouseOver#

              onMouseOver? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseOver

              -

              Defined in node_modules/@types/react/index.d.ts:1482

              +

              Defined in node_modules/@types/react/index.d.ts:1484


              Optional onMouseOverCapture#

              onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseOverCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1483

              +

              Defined in node_modules/@types/react/index.d.ts:1485


              Optional onMouseUp#

              onMouseUp? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseUp

              -

              Defined in node_modules/@types/react/index.d.ts:1484

              +

              Defined in node_modules/@types/react/index.d.ts:1486


              Optional onMouseUpCapture#

              onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onMouseUpCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1485

              +

              Defined in node_modules/@types/react/index.d.ts:1487


              Optional onPaste#

              onPaste? : ClipboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPaste

              -

              Defined in node_modules/@types/react/index.d.ts:1358

              +

              Defined in node_modules/@types/react/index.d.ts:1360


              Optional onPasteCapture#

              onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPasteCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1359

              +

              Defined in node_modules/@types/react/index.d.ts:1361


              Optional onPause#

              onPause? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPause

              -

              Defined in node_modules/@types/react/index.d.ts:1424

              +

              Defined in node_modules/@types/react/index.d.ts:1426


              Optional onPauseCapture#

              onPauseCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPauseCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1425

              +

              Defined in node_modules/@types/react/index.d.ts:1427


              Optional onPlay#

              onPlay? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPlay

              -

              Defined in node_modules/@types/react/index.d.ts:1426

              +

              Defined in node_modules/@types/react/index.d.ts:1428


              Optional onPlayCapture#

              onPlayCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPlayCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1427

              +

              Defined in node_modules/@types/react/index.d.ts:1429


              Optional onPlaying#

              onPlaying? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPlaying

              -

              Defined in node_modules/@types/react/index.d.ts:1428

              +

              Defined in node_modules/@types/react/index.d.ts:1430


              Optional onPlayingCapture#

              onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPlayingCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1429

              +

              Defined in node_modules/@types/react/index.d.ts:1431


              Optional onPointerCancel#

              onPointerCancel? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerCancel

              -

              Defined in node_modules/@types/react/index.d.ts:1508

              +

              Defined in node_modules/@types/react/index.d.ts:1510


              Optional onPointerCancelCapture#

              onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerCancelCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1509

              +

              Defined in node_modules/@types/react/index.d.ts:1511


              Optional onPointerDown#

              onPointerDown? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerDown

              -

              Defined in node_modules/@types/react/index.d.ts:1502

              +

              Defined in node_modules/@types/react/index.d.ts:1504


              Optional onPointerDownCapture#

              onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerDownCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1503

              +

              Defined in node_modules/@types/react/index.d.ts:1505


              Optional onPointerEnter#

              onPointerEnter? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerEnter

              -

              Defined in node_modules/@types/react/index.d.ts:1510

              +

              Defined in node_modules/@types/react/index.d.ts:1512


              Optional onPointerEnterCapture#

              onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerEnterCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1511

              +

              Defined in node_modules/@types/react/index.d.ts:1513


              Optional onPointerLeave#

              onPointerLeave? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerLeave

              -

              Defined in node_modules/@types/react/index.d.ts:1512

              +

              Defined in node_modules/@types/react/index.d.ts:1514


              Optional onPointerLeaveCapture#

              onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerLeaveCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1513

              +

              Defined in node_modules/@types/react/index.d.ts:1515


              Optional onPointerMove#

              onPointerMove? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerMove

              -

              Defined in node_modules/@types/react/index.d.ts:1504

              +

              Defined in node_modules/@types/react/index.d.ts:1506


              Optional onPointerMoveCapture#

              onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerMoveCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1505

              +

              Defined in node_modules/@types/react/index.d.ts:1507


              Optional onPointerOut#

              onPointerOut? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerOut

              -

              Defined in node_modules/@types/react/index.d.ts:1516

              +

              Defined in node_modules/@types/react/index.d.ts:1518


              Optional onPointerOutCapture#

              onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerOutCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1517

              +

              Defined in node_modules/@types/react/index.d.ts:1519


              Optional onPointerOver#

              onPointerOver? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerOver

              -

              Defined in node_modules/@types/react/index.d.ts:1514

              +

              Defined in node_modules/@types/react/index.d.ts:1516


              Optional onPointerOverCapture#

              onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerOverCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1515

              +

              Defined in node_modules/@types/react/index.d.ts:1517


              Optional onPointerUp#

              onPointerUp? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerUp

              -

              Defined in node_modules/@types/react/index.d.ts:1506

              +

              Defined in node_modules/@types/react/index.d.ts:1508


              Optional onPointerUpCapture#

              onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onPointerUpCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1507

              +

              Defined in node_modules/@types/react/index.d.ts:1509


              Optional onProgress#

              onProgress? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onProgress

              -

              Defined in node_modules/@types/react/index.d.ts:1430

              +

              Defined in node_modules/@types/react/index.d.ts:1432


              Optional onProgressCapture#

              onProgressCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onProgressCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1431

              +

              Defined in node_modules/@types/react/index.d.ts:1433


              Optional onRateChange#

              onRateChange? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onRateChange

              -

              Defined in node_modules/@types/react/index.d.ts:1432

              +

              Defined in node_modules/@types/react/index.d.ts:1434


              Optional onRateChangeCapture#

              onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onRateChangeCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1433

              +

              Defined in node_modules/@types/react/index.d.ts:1435


              Optional onReset#

              onReset? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onReset

              -

              Defined in node_modules/@types/react/index.d.ts:1382

              +

              Defined in node_modules/@types/react/index.d.ts:1384


              Optional onResetCapture#

              onResetCapture? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onResetCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1383

              +

              Defined in node_modules/@types/react/index.d.ts:1385


              Optional onScroll#

              onScroll? : UIEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onScroll

              -

              Defined in node_modules/@types/react/index.d.ts:1524

              +

              Defined in node_modules/@types/react/index.d.ts:1526


              Optional onScrollCapture#

              onScrollCapture? : UIEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onScrollCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1525

              +

              Defined in node_modules/@types/react/index.d.ts:1527


              Optional onSeeked#

              onSeeked? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSeeked

              -

              Defined in node_modules/@types/react/index.d.ts:1434

              +

              Defined in node_modules/@types/react/index.d.ts:1436


              Optional onSeekedCapture#

              onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSeekedCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1435

              +

              Defined in node_modules/@types/react/index.d.ts:1437


              Optional onSeeking#

              onSeeking? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSeeking

              -

              Defined in node_modules/@types/react/index.d.ts:1436

              +

              Defined in node_modules/@types/react/index.d.ts:1438


              Optional onSeekingCapture#

              onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSeekingCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1437

              +

              Defined in node_modules/@types/react/index.d.ts:1439


              Optional onSelect#

              onSelect? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSelect

              -

              Defined in node_modules/@types/react/index.d.ts:1488

              +

              Defined in node_modules/@types/react/index.d.ts:1490


              Optional onSelectCapture#

              onSelectCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSelectCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1489

              +

              Defined in node_modules/@types/react/index.d.ts:1491


              Optional onStalled#

              onStalled? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onStalled

              -

              Defined in node_modules/@types/react/index.d.ts:1438

              +

              Defined in node_modules/@types/react/index.d.ts:1440


              Optional onStalledCapture#

              onStalledCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onStalledCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1439

              +

              Defined in node_modules/@types/react/index.d.ts:1441


              Optional onSubmit#

              onSubmit? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSubmit

              -

              Defined in node_modules/@types/react/index.d.ts:1384

              +

              Defined in node_modules/@types/react/index.d.ts:1386


              Optional onSubmitCapture#

              onSubmitCapture? : FormEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSubmitCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1385

              +

              Defined in node_modules/@types/react/index.d.ts:1387


              Optional onSuspend#

              onSuspend? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSuspend

              -

              Defined in node_modules/@types/react/index.d.ts:1440

              +

              Defined in node_modules/@types/react/index.d.ts:1442


              Optional onSuspendCapture#

              onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onSuspendCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1441

              +

              Defined in node_modules/@types/react/index.d.ts:1443


              Optional onTimeUpdate#

              onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTimeUpdate

              -

              Defined in node_modules/@types/react/index.d.ts:1442

              +

              Defined in node_modules/@types/react/index.d.ts:1444


              Optional onTimeUpdateCapture#

              onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTimeUpdateCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1443

              +

              Defined in node_modules/@types/react/index.d.ts:1445


              Optional onTouchCancel#

              onTouchCancel? : TouchEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTouchCancel

              -

              Defined in node_modules/@types/react/index.d.ts:1492

              +

              Defined in node_modules/@types/react/index.d.ts:1494


              Optional onTouchCancelCapture#

              onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTouchCancelCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1493

              +

              Defined in node_modules/@types/react/index.d.ts:1495


              Optional onTouchEnd#

              onTouchEnd? : TouchEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTouchEnd

              -

              Defined in node_modules/@types/react/index.d.ts:1494

              +

              Defined in node_modules/@types/react/index.d.ts:1496


              Optional onTouchEndCapture#

              onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTouchEndCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1495

              +

              Defined in node_modules/@types/react/index.d.ts:1497


              Optional onTouchMove#

              onTouchMove? : TouchEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTouchMove

              -

              Defined in node_modules/@types/react/index.d.ts:1496

              +

              Defined in node_modules/@types/react/index.d.ts:1498


              Optional onTouchMoveCapture#

              onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTouchMoveCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1497

              +

              Defined in node_modules/@types/react/index.d.ts:1499


              Optional onTouchStart#

              onTouchStart? : TouchEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTouchStart

              -

              Defined in node_modules/@types/react/index.d.ts:1498

              +

              Defined in node_modules/@types/react/index.d.ts:1500


              Optional onTouchStartCapture#

              onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTouchStartCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1499

              +

              Defined in node_modules/@types/react/index.d.ts:1501


              Optional onTransitionEnd#

              onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTransitionEnd

              -

              Defined in node_modules/@types/react/index.d.ts:1540

              +

              Defined in node_modules/@types/react/index.d.ts:1542


              Optional onTransitionEndCapture#

              onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onTransitionEndCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1541

              +

              Defined in node_modules/@types/react/index.d.ts:1543


              Optional onVolumeChange#

              onVolumeChange? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onVolumeChange

              -

              Defined in node_modules/@types/react/index.d.ts:1444

              +

              Defined in node_modules/@types/react/index.d.ts:1446


              Optional onVolumeChangeCapture#

              onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onVolumeChangeCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1445

              +

              Defined in node_modules/@types/react/index.d.ts:1447


              Optional onWaiting#

              onWaiting? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onWaiting

              -

              Defined in node_modules/@types/react/index.d.ts:1446

              +

              Defined in node_modules/@types/react/index.d.ts:1448


              Optional onWaitingCapture#

              onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onWaitingCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1447

              +

              Defined in node_modules/@types/react/index.d.ts:1449


              Optional onWheel#

              onWheel? : WheelEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onWheel

              -

              Defined in node_modules/@types/react/index.d.ts:1528

              +

              Defined in node_modules/@types/react/index.d.ts:1530


              Optional onWheelCapture#

              onWheelCapture? : WheelEventHandler‹HTMLDivElement›

              Inherited from PageLayoutProps.onWheelCapture

              -

              Defined in node_modules/@types/react/index.d.ts:1529

              +

              Defined in node_modules/@types/react/index.d.ts:1531


              Optional searchItem#

              searchItem? : ItemObject | any

              -

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

              +

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


              Optional selected#

              selected? : boolean

              -

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

              +

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


              Optional sortItem#

              sortItem? : ItemObject | any

              -

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

              +

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


              Optional style#

              style? : CSSProperties

              -

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

              +

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

              diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html index ec07539222..faa332b438 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html @@ -598,7 +598,7 @@
            • - Working with mobx + Working with MobX
            • @@ -895,6 +895,13 @@ Optional icon + + +
            • + + Optional id + +
            • @@ -2067,6 +2074,7 @@
            • dangerouslySetInnerHTML
            • disabled
            • icon
            • +
            • id
            • label
            • onAbort
            • onAbortCapture
            • @@ -2233,21 +2241,21 @@

              Properties#

              Optional active#

              active? : boolean

              -

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

              +

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


              Optional children#

              children? : ReactNode

              Inherited from PageLayoutProps.children

              -

              Defined in node_modules/@types/react/index.d.ts:1348

              +

              Defined in node_modules/@types/react/index.d.ts:1350


              Optional className#

              className? : string

              -

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

              +

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


              Optional dangerouslySetInnerHTML#

              dangerouslySetInnerHTML? : object

              Inherited from PageLayoutProps.dangerouslySetInnerHTML

              -

              Defined in node_modules/@types/react/index.d.ts:1349

              +

              Defined in node_modules/@types/react/index.d.ts:1351

              Type declaration:

              • __html: string
              • @@ -2255,819 +2263,823 @@

                Optional disabled#

                disabled? : boolean

                -

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

                +

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


                Optional icon#

                icon? : React.ReactNode | string

                -

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

                +

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

                +
                +

                Optional id#

                +

                id? : string

                +

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


                Optional label#

                label? : React.ReactNode

                -

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

                +

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


                Optional onAbort#

                onAbort? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAbort

                -

                Defined in node_modules/@types/react/index.d.ts:1404

                +

                Defined in node_modules/@types/react/index.d.ts:1406


                Optional onAbortCapture#

                onAbortCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAbortCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1405

                +

                Defined in node_modules/@types/react/index.d.ts:1407


                Optional onAnimationEnd#

                onAnimationEnd? : AnimationEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAnimationEnd

                -

                Defined in node_modules/@types/react/index.d.ts:1534

                +

                Defined in node_modules/@types/react/index.d.ts:1536


                Optional onAnimationEndCapture#

                onAnimationEndCapture? : AnimationEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAnimationEndCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1535

                +

                Defined in node_modules/@types/react/index.d.ts:1537


                Optional onAnimationIteration#

                onAnimationIteration? : AnimationEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAnimationIteration

                -

                Defined in node_modules/@types/react/index.d.ts:1536

                +

                Defined in node_modules/@types/react/index.d.ts:1538


                Optional onAnimationIterationCapture#

                onAnimationIterationCapture? : AnimationEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAnimationIterationCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1537

                +

                Defined in node_modules/@types/react/index.d.ts:1539


                Optional onAnimationStart#

                onAnimationStart? : AnimationEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAnimationStart

                -

                Defined in node_modules/@types/react/index.d.ts:1532

                +

                Defined in node_modules/@types/react/index.d.ts:1534


                Optional onAnimationStartCapture#

                onAnimationStartCapture? : AnimationEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAnimationStartCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1533

                +

                Defined in node_modules/@types/react/index.d.ts:1535


                Optional onAuxClick#

                onAuxClick? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAuxClick

                -

                Defined in node_modules/@types/react/index.d.ts:1450

                +

                Defined in node_modules/@types/react/index.d.ts:1452


                Optional onAuxClickCapture#

                onAuxClickCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onAuxClickCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1451

                +

                Defined in node_modules/@types/react/index.d.ts:1453


                Optional onBeforeInput#

                onBeforeInput? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onBeforeInput

                -

                Defined in node_modules/@types/react/index.d.ts:1378

                +

                Defined in node_modules/@types/react/index.d.ts:1380


                Optional onBeforeInputCapture#

                onBeforeInputCapture? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onBeforeInputCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1379

                +

                Defined in node_modules/@types/react/index.d.ts:1381


                Optional onBlur#

                onBlur? : FocusEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onBlur

                -

                Defined in node_modules/@types/react/index.d.ts:1372

                +

                Defined in node_modules/@types/react/index.d.ts:1374


                Optional onBlurCapture#

                onBlurCapture? : FocusEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onBlurCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1373

                +

                Defined in node_modules/@types/react/index.d.ts:1375


                Optional onCanPlay#

                onCanPlay? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCanPlay

                -

                Defined in node_modules/@types/react/index.d.ts:1406

                +

                Defined in node_modules/@types/react/index.d.ts:1408


                Optional onCanPlayCapture#

                onCanPlayCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCanPlayCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1407

                +

                Defined in node_modules/@types/react/index.d.ts:1409


                Optional onCanPlayThrough#

                onCanPlayThrough? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCanPlayThrough

                -

                Defined in node_modules/@types/react/index.d.ts:1408

                +

                Defined in node_modules/@types/react/index.d.ts:1410


                Optional onCanPlayThroughCapture#

                onCanPlayThroughCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCanPlayThroughCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1409

                +

                Defined in node_modules/@types/react/index.d.ts:1411


                Optional onChange#

                onChange? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onChange

                -

                Defined in node_modules/@types/react/index.d.ts:1376

                +

                Defined in node_modules/@types/react/index.d.ts:1378


                Optional onChangeCapture#

                onChangeCapture? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onChangeCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1377

                +

                Defined in node_modules/@types/react/index.d.ts:1379


                Optional onClick#

                onClick? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onClick

                -

                Defined in node_modules/@types/react/index.d.ts:1452

                +

                Defined in node_modules/@types/react/index.d.ts:1454


                Optional onClickCapture#

                onClickCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onClickCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1453

                +

                Defined in node_modules/@types/react/index.d.ts:1455


                Optional onCompositionEnd#

                onCompositionEnd? : CompositionEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCompositionEnd

                -

                Defined in node_modules/@types/react/index.d.ts:1362

                +

                Defined in node_modules/@types/react/index.d.ts:1364


                Optional onCompositionEndCapture#

                onCompositionEndCapture? : CompositionEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCompositionEndCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1363

                +

                Defined in node_modules/@types/react/index.d.ts:1365


                Optional onCompositionStart#

                onCompositionStart? : CompositionEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCompositionStart

                -

                Defined in node_modules/@types/react/index.d.ts:1364

                +

                Defined in node_modules/@types/react/index.d.ts:1366


                Optional onCompositionStartCapture#

                onCompositionStartCapture? : CompositionEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCompositionStartCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1365

                +

                Defined in node_modules/@types/react/index.d.ts:1367


                Optional onCompositionUpdate#

                onCompositionUpdate? : CompositionEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCompositionUpdate

                -

                Defined in node_modules/@types/react/index.d.ts:1366

                +

                Defined in node_modules/@types/react/index.d.ts:1368


                Optional onCompositionUpdateCapture#

                onCompositionUpdateCapture? : CompositionEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCompositionUpdateCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1367

                +

                Defined in node_modules/@types/react/index.d.ts:1369


                Optional onContextMenu#

                onContextMenu? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onContextMenu

                -

                Defined in node_modules/@types/react/index.d.ts:1454

                +

                Defined in node_modules/@types/react/index.d.ts:1456


                Optional onContextMenuCapture#

                onContextMenuCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onContextMenuCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1455

                +

                Defined in node_modules/@types/react/index.d.ts:1457


                Optional onCopy#

                onCopy? : ClipboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCopy

                -

                Defined in node_modules/@types/react/index.d.ts:1354

                +

                Defined in node_modules/@types/react/index.d.ts:1356


                Optional onCopyCapture#

                onCopyCapture? : ClipboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCopyCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1355

                +

                Defined in node_modules/@types/react/index.d.ts:1357


                Optional onCut#

                onCut? : ClipboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCut

                -

                Defined in node_modules/@types/react/index.d.ts:1356

                +

                Defined in node_modules/@types/react/index.d.ts:1358


                Optional onCutCapture#

                onCutCapture? : ClipboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onCutCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1357

                +

                Defined in node_modules/@types/react/index.d.ts:1359


                Optional onDoubleClick#

                onDoubleClick? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDoubleClick

                -

                Defined in node_modules/@types/react/index.d.ts:1456

                +

                Defined in node_modules/@types/react/index.d.ts:1458


                Optional onDoubleClickCapture#

                onDoubleClickCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDoubleClickCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1457

                +

                Defined in node_modules/@types/react/index.d.ts:1459


                Optional onDrag#

                onDrag? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDrag

                -

                Defined in node_modules/@types/react/index.d.ts:1458

                +

                Defined in node_modules/@types/react/index.d.ts:1460


                Optional onDragCapture#

                onDragCapture? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1459

                +

                Defined in node_modules/@types/react/index.d.ts:1461


                Optional onDragEnd#

                onDragEnd? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragEnd

                -

                Defined in node_modules/@types/react/index.d.ts:1460

                +

                Defined in node_modules/@types/react/index.d.ts:1462


                Optional onDragEndCapture#

                onDragEndCapture? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragEndCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1461

                +

                Defined in node_modules/@types/react/index.d.ts:1463


                Optional onDragEnter#

                onDragEnter? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragEnter

                -

                Defined in node_modules/@types/react/index.d.ts:1462

                +

                Defined in node_modules/@types/react/index.d.ts:1464


                Optional onDragEnterCapture#

                onDragEnterCapture? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragEnterCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1463

                +

                Defined in node_modules/@types/react/index.d.ts:1465


                Optional onDragExit#

                onDragExit? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragExit

                -

                Defined in node_modules/@types/react/index.d.ts:1464

                +

                Defined in node_modules/@types/react/index.d.ts:1466


                Optional onDragExitCapture#

                onDragExitCapture? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragExitCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1465

                +

                Defined in node_modules/@types/react/index.d.ts:1467


                Optional onDragLeave#

                onDragLeave? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragLeave

                -

                Defined in node_modules/@types/react/index.d.ts:1466

                +

                Defined in node_modules/@types/react/index.d.ts:1468


                Optional onDragLeaveCapture#

                onDragLeaveCapture? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragLeaveCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1467

                +

                Defined in node_modules/@types/react/index.d.ts:1469


                Optional onDragOver#

                onDragOver? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragOver

                -

                Defined in node_modules/@types/react/index.d.ts:1468

                +

                Defined in node_modules/@types/react/index.d.ts:1470


                Optional onDragOverCapture#

                onDragOverCapture? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragOverCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1469

                +

                Defined in node_modules/@types/react/index.d.ts:1471


                Optional onDragStart#

                onDragStart? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragStart

                -

                Defined in node_modules/@types/react/index.d.ts:1470

                +

                Defined in node_modules/@types/react/index.d.ts:1472


                Optional onDragStartCapture#

                onDragStartCapture? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDragStartCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1471

                +

                Defined in node_modules/@types/react/index.d.ts:1473


                Optional onDrop#

                onDrop? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDrop

                -

                Defined in node_modules/@types/react/index.d.ts:1472

                +

                Defined in node_modules/@types/react/index.d.ts:1474


                Optional onDropCapture#

                onDropCapture? : DragEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDropCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1473

                +

                Defined in node_modules/@types/react/index.d.ts:1475


                Optional onDurationChange#

                onDurationChange? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDurationChange

                -

                Defined in node_modules/@types/react/index.d.ts:1410

                +

                Defined in node_modules/@types/react/index.d.ts:1412


                Optional onDurationChangeCapture#

                onDurationChangeCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onDurationChangeCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1411

                +

                Defined in node_modules/@types/react/index.d.ts:1413


                Optional onEmptied#

                onEmptied? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onEmptied

                -

                Defined in node_modules/@types/react/index.d.ts:1412

                +

                Defined in node_modules/@types/react/index.d.ts:1414


                Optional onEmptiedCapture#

                onEmptiedCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onEmptiedCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1413

                +

                Defined in node_modules/@types/react/index.d.ts:1415


                Optional onEncrypted#

                onEncrypted? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onEncrypted

                -

                Defined in node_modules/@types/react/index.d.ts:1414

                +

                Defined in node_modules/@types/react/index.d.ts:1416


                Optional onEncryptedCapture#

                onEncryptedCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onEncryptedCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1415

                +

                Defined in node_modules/@types/react/index.d.ts:1417


                Optional onEnded#

                onEnded? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onEnded

                -

                Defined in node_modules/@types/react/index.d.ts:1416

                +

                Defined in node_modules/@types/react/index.d.ts:1418


                Optional onEndedCapture#

                onEndedCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onEndedCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1417

                +

                Defined in node_modules/@types/react/index.d.ts:1419


                Optional onError#

                onError? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onError

                -

                Defined in node_modules/@types/react/index.d.ts:1392

                +

                Defined in node_modules/@types/react/index.d.ts:1394


                Optional onErrorCapture#

                onErrorCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onErrorCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1393

                +

                Defined in node_modules/@types/react/index.d.ts:1395


                Optional onFocus#

                onFocus? : FocusEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onFocus

                -

                Defined in node_modules/@types/react/index.d.ts:1370

                +

                Defined in node_modules/@types/react/index.d.ts:1372


                Optional onFocusCapture#

                onFocusCapture? : FocusEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onFocusCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1371

                +

                Defined in node_modules/@types/react/index.d.ts:1373


                Optional onGotPointerCapture#

                onGotPointerCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onGotPointerCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1518

                +

                Defined in node_modules/@types/react/index.d.ts:1520


                Optional onGotPointerCaptureCapture#

                onGotPointerCaptureCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onGotPointerCaptureCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1519

                +

                Defined in node_modules/@types/react/index.d.ts:1521


                Optional onInput#

                onInput? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onInput

                -

                Defined in node_modules/@types/react/index.d.ts:1380

                +

                Defined in node_modules/@types/react/index.d.ts:1382


                Optional onInputCapture#

                onInputCapture? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onInputCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1381

                +

                Defined in node_modules/@types/react/index.d.ts:1383


                Optional onInvalid#

                onInvalid? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onInvalid

                -

                Defined in node_modules/@types/react/index.d.ts:1386

                +

                Defined in node_modules/@types/react/index.d.ts:1388


                Optional onInvalidCapture#

                onInvalidCapture? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onInvalidCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1387

                +

                Defined in node_modules/@types/react/index.d.ts:1389


                Optional onKeyDown#

                onKeyDown? : KeyboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onKeyDown

                -

                Defined in node_modules/@types/react/index.d.ts:1396

                +

                Defined in node_modules/@types/react/index.d.ts:1398


                Optional onKeyDownCapture#

                onKeyDownCapture? : KeyboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onKeyDownCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1397

                +

                Defined in node_modules/@types/react/index.d.ts:1399


                Optional onKeyPress#

                onKeyPress? : KeyboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onKeyPress

                -

                Defined in node_modules/@types/react/index.d.ts:1398

                +

                Defined in node_modules/@types/react/index.d.ts:1400


                Optional onKeyPressCapture#

                onKeyPressCapture? : KeyboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onKeyPressCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1399

                +

                Defined in node_modules/@types/react/index.d.ts:1401


                Optional onKeyUp#

                onKeyUp? : KeyboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onKeyUp

                -

                Defined in node_modules/@types/react/index.d.ts:1400

                +

                Defined in node_modules/@types/react/index.d.ts:1402


                Optional onKeyUpCapture#

                onKeyUpCapture? : KeyboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onKeyUpCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1401

                +

                Defined in node_modules/@types/react/index.d.ts:1403


                Optional onLoad#

                onLoad? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLoad

                -

                Defined in node_modules/@types/react/index.d.ts:1390

                +

                Defined in node_modules/@types/react/index.d.ts:1392


                Optional onLoadCapture#

                onLoadCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLoadCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1391

                +

                Defined in node_modules/@types/react/index.d.ts:1393


                Optional onLoadStart#

                onLoadStart? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLoadStart

                -

                Defined in node_modules/@types/react/index.d.ts:1422

                +

                Defined in node_modules/@types/react/index.d.ts:1424


                Optional onLoadStartCapture#

                onLoadStartCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLoadStartCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1423

                +

                Defined in node_modules/@types/react/index.d.ts:1425


                Optional onLoadedData#

                onLoadedData? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLoadedData

                -

                Defined in node_modules/@types/react/index.d.ts:1418

                +

                Defined in node_modules/@types/react/index.d.ts:1420


                Optional onLoadedDataCapture#

                onLoadedDataCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLoadedDataCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1419

                +

                Defined in node_modules/@types/react/index.d.ts:1421


                Optional onLoadedMetadata#

                onLoadedMetadata? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLoadedMetadata

                -

                Defined in node_modules/@types/react/index.d.ts:1420

                +

                Defined in node_modules/@types/react/index.d.ts:1422


                Optional onLoadedMetadataCapture#

                onLoadedMetadataCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLoadedMetadataCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1421

                +

                Defined in node_modules/@types/react/index.d.ts:1423


                Optional onLostPointerCapture#

                onLostPointerCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLostPointerCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1520

                +

                Defined in node_modules/@types/react/index.d.ts:1522


                Optional onLostPointerCaptureCapture#

                onLostPointerCaptureCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onLostPointerCaptureCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1521

                +

                Defined in node_modules/@types/react/index.d.ts:1523


                Optional onMouseDown#

                onMouseDown? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseDown

                -

                Defined in node_modules/@types/react/index.d.ts:1474

                +

                Defined in node_modules/@types/react/index.d.ts:1476


                Optional onMouseDownCapture#

                onMouseDownCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseDownCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1475

                +

                Defined in node_modules/@types/react/index.d.ts:1477


                Optional onMouseEnter#

                onMouseEnter? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseEnter

                -

                Defined in node_modules/@types/react/index.d.ts:1476

                +

                Defined in node_modules/@types/react/index.d.ts:1478


                Optional onMouseLeave#

                onMouseLeave? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseLeave

                -

                Defined in node_modules/@types/react/index.d.ts:1477

                +

                Defined in node_modules/@types/react/index.d.ts:1479


                Optional onMouseMove#

                onMouseMove? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseMove

                -

                Defined in node_modules/@types/react/index.d.ts:1478

                +

                Defined in node_modules/@types/react/index.d.ts:1480


                Optional onMouseMoveCapture#

                onMouseMoveCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseMoveCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1479

                +

                Defined in node_modules/@types/react/index.d.ts:1481


                Optional onMouseOut#

                onMouseOut? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseOut

                -

                Defined in node_modules/@types/react/index.d.ts:1480

                +

                Defined in node_modules/@types/react/index.d.ts:1482


                Optional onMouseOutCapture#

                onMouseOutCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseOutCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1481

                +

                Defined in node_modules/@types/react/index.d.ts:1483


                Optional onMouseOver#

                onMouseOver? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseOver

                -

                Defined in node_modules/@types/react/index.d.ts:1482

                +

                Defined in node_modules/@types/react/index.d.ts:1484


                Optional onMouseOverCapture#

                onMouseOverCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseOverCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1483

                +

                Defined in node_modules/@types/react/index.d.ts:1485


                Optional onMouseUp#

                onMouseUp? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseUp

                -

                Defined in node_modules/@types/react/index.d.ts:1484

                +

                Defined in node_modules/@types/react/index.d.ts:1486


                Optional onMouseUpCapture#

                onMouseUpCapture? : MouseEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onMouseUpCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1485

                +

                Defined in node_modules/@types/react/index.d.ts:1487


                Optional onPaste#

                onPaste? : ClipboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPaste

                -

                Defined in node_modules/@types/react/index.d.ts:1358

                +

                Defined in node_modules/@types/react/index.d.ts:1360


                Optional onPasteCapture#

                onPasteCapture? : ClipboardEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPasteCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1359

                +

                Defined in node_modules/@types/react/index.d.ts:1361


                Optional onPause#

                onPause? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPause

                -

                Defined in node_modules/@types/react/index.d.ts:1424

                +

                Defined in node_modules/@types/react/index.d.ts:1426


                Optional onPauseCapture#

                onPauseCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPauseCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1425

                +

                Defined in node_modules/@types/react/index.d.ts:1427


                Optional onPlay#

                onPlay? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPlay

                -

                Defined in node_modules/@types/react/index.d.ts:1426

                +

                Defined in node_modules/@types/react/index.d.ts:1428


                Optional onPlayCapture#

                onPlayCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPlayCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1427

                +

                Defined in node_modules/@types/react/index.d.ts:1429


                Optional onPlaying#

                onPlaying? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPlaying

                -

                Defined in node_modules/@types/react/index.d.ts:1428

                +

                Defined in node_modules/@types/react/index.d.ts:1430


                Optional onPlayingCapture#

                onPlayingCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPlayingCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1429

                +

                Defined in node_modules/@types/react/index.d.ts:1431


                Optional onPointerCancel#

                onPointerCancel? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerCancel

                -

                Defined in node_modules/@types/react/index.d.ts:1508

                +

                Defined in node_modules/@types/react/index.d.ts:1510


                Optional onPointerCancelCapture#

                onPointerCancelCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerCancelCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1509

                +

                Defined in node_modules/@types/react/index.d.ts:1511


                Optional onPointerDown#

                onPointerDown? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerDown

                -

                Defined in node_modules/@types/react/index.d.ts:1502

                +

                Defined in node_modules/@types/react/index.d.ts:1504


                Optional onPointerDownCapture#

                onPointerDownCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerDownCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1503

                +

                Defined in node_modules/@types/react/index.d.ts:1505


                Optional onPointerEnter#

                onPointerEnter? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerEnter

                -

                Defined in node_modules/@types/react/index.d.ts:1510

                +

                Defined in node_modules/@types/react/index.d.ts:1512


                Optional onPointerEnterCapture#

                onPointerEnterCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerEnterCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1511

                +

                Defined in node_modules/@types/react/index.d.ts:1513


                Optional onPointerLeave#

                onPointerLeave? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerLeave

                -

                Defined in node_modules/@types/react/index.d.ts:1512

                +

                Defined in node_modules/@types/react/index.d.ts:1514


                Optional onPointerLeaveCapture#

                onPointerLeaveCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerLeaveCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1513

                +

                Defined in node_modules/@types/react/index.d.ts:1515


                Optional onPointerMove#

                onPointerMove? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerMove

                -

                Defined in node_modules/@types/react/index.d.ts:1504

                +

                Defined in node_modules/@types/react/index.d.ts:1506


                Optional onPointerMoveCapture#

                onPointerMoveCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerMoveCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1505

                +

                Defined in node_modules/@types/react/index.d.ts:1507


                Optional onPointerOut#

                onPointerOut? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerOut

                -

                Defined in node_modules/@types/react/index.d.ts:1516

                +

                Defined in node_modules/@types/react/index.d.ts:1518


                Optional onPointerOutCapture#

                onPointerOutCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerOutCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1517

                +

                Defined in node_modules/@types/react/index.d.ts:1519


                Optional onPointerOver#

                onPointerOver? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerOver

                -

                Defined in node_modules/@types/react/index.d.ts:1514

                +

                Defined in node_modules/@types/react/index.d.ts:1516


                Optional onPointerOverCapture#

                onPointerOverCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerOverCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1515

                +

                Defined in node_modules/@types/react/index.d.ts:1517


                Optional onPointerUp#

                onPointerUp? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerUp

                -

                Defined in node_modules/@types/react/index.d.ts:1506

                +

                Defined in node_modules/@types/react/index.d.ts:1508


                Optional onPointerUpCapture#

                onPointerUpCapture? : PointerEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onPointerUpCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1507

                +

                Defined in node_modules/@types/react/index.d.ts:1509


                Optional onProgress#

                onProgress? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onProgress

                -

                Defined in node_modules/@types/react/index.d.ts:1430

                +

                Defined in node_modules/@types/react/index.d.ts:1432


                Optional onProgressCapture#

                onProgressCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onProgressCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1431

                +

                Defined in node_modules/@types/react/index.d.ts:1433


                Optional onRateChange#

                onRateChange? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onRateChange

                -

                Defined in node_modules/@types/react/index.d.ts:1432

                +

                Defined in node_modules/@types/react/index.d.ts:1434


                Optional onRateChangeCapture#

                onRateChangeCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onRateChangeCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1433

                +

                Defined in node_modules/@types/react/index.d.ts:1435


                Optional onReset#

                onReset? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onReset

                -

                Defined in node_modules/@types/react/index.d.ts:1382

                +

                Defined in node_modules/@types/react/index.d.ts:1384


                Optional onResetCapture#

                onResetCapture? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onResetCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1383

                +

                Defined in node_modules/@types/react/index.d.ts:1385


                Optional onScroll#

                onScroll? : UIEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onScroll

                -

                Defined in node_modules/@types/react/index.d.ts:1524

                +

                Defined in node_modules/@types/react/index.d.ts:1526


                Optional onScrollCapture#

                onScrollCapture? : UIEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onScrollCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1525

                +

                Defined in node_modules/@types/react/index.d.ts:1527


                Optional onSeeked#

                onSeeked? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSeeked

                -

                Defined in node_modules/@types/react/index.d.ts:1434

                +

                Defined in node_modules/@types/react/index.d.ts:1436


                Optional onSeekedCapture#

                onSeekedCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSeekedCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1435

                +

                Defined in node_modules/@types/react/index.d.ts:1437


                Optional onSeeking#

                onSeeking? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSeeking

                -

                Defined in node_modules/@types/react/index.d.ts:1436

                +

                Defined in node_modules/@types/react/index.d.ts:1438


                Optional onSeekingCapture#

                onSeekingCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSeekingCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1437

                +

                Defined in node_modules/@types/react/index.d.ts:1439


                Optional onSelect#

                onSelect? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSelect

                -

                Defined in node_modules/@types/react/index.d.ts:1488

                +

                Defined in node_modules/@types/react/index.d.ts:1490


                Optional onSelectCapture#

                onSelectCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSelectCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1489

                +

                Defined in node_modules/@types/react/index.d.ts:1491


                Optional onStalled#

                onStalled? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onStalled

                -

                Defined in node_modules/@types/react/index.d.ts:1438

                +

                Defined in node_modules/@types/react/index.d.ts:1440


                Optional onStalledCapture#

                onStalledCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onStalledCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1439

                +

                Defined in node_modules/@types/react/index.d.ts:1441


                Optional onSubmit#

                onSubmit? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSubmit

                -

                Defined in node_modules/@types/react/index.d.ts:1384

                +

                Defined in node_modules/@types/react/index.d.ts:1386


                Optional onSubmitCapture#

                onSubmitCapture? : FormEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSubmitCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1385

                +

                Defined in node_modules/@types/react/index.d.ts:1387


                Optional onSuspend#

                onSuspend? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSuspend

                -

                Defined in node_modules/@types/react/index.d.ts:1440

                +

                Defined in node_modules/@types/react/index.d.ts:1442


                Optional onSuspendCapture#

                onSuspendCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onSuspendCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1441

                +

                Defined in node_modules/@types/react/index.d.ts:1443


                Optional onTimeUpdate#

                onTimeUpdate? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTimeUpdate

                -

                Defined in node_modules/@types/react/index.d.ts:1442

                +

                Defined in node_modules/@types/react/index.d.ts:1444


                Optional onTimeUpdateCapture#

                onTimeUpdateCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTimeUpdateCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1443

                +

                Defined in node_modules/@types/react/index.d.ts:1445


                Optional onTouchCancel#

                onTouchCancel? : TouchEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTouchCancel

                -

                Defined in node_modules/@types/react/index.d.ts:1492

                +

                Defined in node_modules/@types/react/index.d.ts:1494


                Optional onTouchCancelCapture#

                onTouchCancelCapture? : TouchEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTouchCancelCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1493

                +

                Defined in node_modules/@types/react/index.d.ts:1495


                Optional onTouchEnd#

                onTouchEnd? : TouchEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTouchEnd

                -

                Defined in node_modules/@types/react/index.d.ts:1494

                +

                Defined in node_modules/@types/react/index.d.ts:1496


                Optional onTouchEndCapture#

                onTouchEndCapture? : TouchEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTouchEndCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1495

                +

                Defined in node_modules/@types/react/index.d.ts:1497


                Optional onTouchMove#

                onTouchMove? : TouchEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTouchMove

                -

                Defined in node_modules/@types/react/index.d.ts:1496

                +

                Defined in node_modules/@types/react/index.d.ts:1498


                Optional onTouchMoveCapture#

                onTouchMoveCapture? : TouchEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTouchMoveCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1497

                +

                Defined in node_modules/@types/react/index.d.ts:1499


                Optional onTouchStart#

                onTouchStart? : TouchEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTouchStart

                -

                Defined in node_modules/@types/react/index.d.ts:1498

                +

                Defined in node_modules/@types/react/index.d.ts:1500


                Optional onTouchStartCapture#

                onTouchStartCapture? : TouchEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTouchStartCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1499

                +

                Defined in node_modules/@types/react/index.d.ts:1501


                Optional onTransitionEnd#

                onTransitionEnd? : TransitionEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTransitionEnd

                -

                Defined in node_modules/@types/react/index.d.ts:1540

                +

                Defined in node_modules/@types/react/index.d.ts:1542


                Optional onTransitionEndCapture#

                onTransitionEndCapture? : TransitionEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onTransitionEndCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1541

                +

                Defined in node_modules/@types/react/index.d.ts:1543


                Optional onVolumeChange#

                onVolumeChange? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onVolumeChange

                -

                Defined in node_modules/@types/react/index.d.ts:1444

                +

                Defined in node_modules/@types/react/index.d.ts:1446


                Optional onVolumeChangeCapture#

                onVolumeChangeCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onVolumeChangeCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1445

                +

                Defined in node_modules/@types/react/index.d.ts:1447


                Optional onWaiting#

                onWaiting? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onWaiting

                -

                Defined in node_modules/@types/react/index.d.ts:1446

                +

                Defined in node_modules/@types/react/index.d.ts:1448


                Optional onWaitingCapture#

                onWaitingCapture? : ReactEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onWaitingCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1447

                +

                Defined in node_modules/@types/react/index.d.ts:1449


                Optional onWheel#

                onWheel? : WheelEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onWheel

                -

                Defined in node_modules/@types/react/index.d.ts:1528

                +

                Defined in node_modules/@types/react/index.d.ts:1530


                Optional onWheelCapture#

                onWheelCapture? : WheelEventHandler‹HTMLElement›

                Inherited from PageLayoutProps.onWheelCapture

                -

                Defined in node_modules/@types/react/index.d.ts:1529

                +

                Defined in node_modules/@types/react/index.d.ts:1531


                value#

                value: D

                -

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

                +

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

                diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html index 3a5868b632..9563cf4ac4 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html @@ -598,7 +598,7 @@
              • - Working with mobx + Working with MobX
              • @@ -982,38 +982,38 @@

                Optional autoFocus#

                autoFocus? : boolean

                Inherited from TabsProps.autoFocus

                -

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

                +

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


                Optional center#

                center? : boolean

                -

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

                +

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


                Optional className#

                className? : string

                -

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

                +

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


                Optional scrollable#

                scrollable? : boolean

                -

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

                +

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


                Optional value#

                value? : D

                Inherited from TabsProps.value

                -

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

                +

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


                Optional withBorder#

                withBorder? : boolean

                Inherited from TabsProps.withBorder

                -

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

                +

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


                Optional wrap#

                wrap? : boolean

                -

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

                +

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

                Methods#

                Optional onChange#

                onChange(value: D): void

                Inherited from TabsProps.onChange

                -

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

                +

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

                Parameters:

      diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html index 726cb8c80f..3d67e4311b 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -919,23 +919,23 @@

      Properties#

      Optional narrow#

      narrow? : boolean

      -

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

      +

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


      Optional nowrap#

      nowrap? : boolean

      -

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

      +

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


      Optional small#

      small? : boolean

      -

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

      +

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


      Optional tableView#

      tableView? : boolean

      -

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

      +

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


      Optional warning#

      warning? : boolean

      -

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

      +

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

      diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html index 19a6494baf..cdbc3eba34 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -900,11 +900,11 @@

      Properties#

      Optional tooltip#

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

      -

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

      +

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


      Optional tooltipOverrideDisabled#

      tooltipOverrideDisabled? : boolean

      -

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

      +

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

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

      diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html index a2777ee63b..76189e1465 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -959,43 +959,43 @@

      Properties#

      Optional children#

      children? : React.ReactNode

      -

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

      +

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


      Optional className#

      className? : IClassName

      -

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

      +

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


      Optional formatters#

      formatters? : TooltipContentFormatters

      -

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

      +

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


      Optional offset#

      offset? : number

      -

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

      +

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


      Optional preferredPositions#

      preferredPositions? : TooltipPosition | TooltipPosition[]

      -

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

      +

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


      Optional style#

      style? : CSSProperties

      -

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

      +

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


      targetId#

      targetId: string

      -

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

      +

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


      Optional tooltipOnParentHover#

      tooltipOnParentHover? : boolean

      -

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

      +

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


      Optional usePortal#

      usePortal? : boolean

      -

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

      +

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


      Optional visible#

      visible? : boolean

      -

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

      +

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

      diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html index 657db8a2da..cead460bff 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -598,7 +598,7 @@
    • - Working with mobx + Working with MobX
    • @@ -2232,25 +2232,25 @@

      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

      Inherited from PageLayoutProps.children

      -

      Defined in node_modules/@types/react/index.d.ts:1348

      +

      Defined in node_modules/@types/react/index.d.ts:1350


      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

      Inherited from PageLayoutProps.dangerouslySetInnerHTML

      -

      Defined in node_modules/@types/react/index.d.ts:1349

      +

      Defined in node_modules/@types/react/index.d.ts:1351

      Type declaration:

      • __html: string
      • @@ -2258,819 +2258,819 @@

        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›

        Inherited from PageLayoutProps.onAbort

        -

        Defined in node_modules/@types/react/index.d.ts:1404

        +

        Defined in node_modules/@types/react/index.d.ts:1406


        Optional onAbortCapture#

        onAbortCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onAbortCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1405

        +

        Defined in node_modules/@types/react/index.d.ts:1407


        Optional onAnimationEnd#

        onAnimationEnd? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1534

        +

        Defined in node_modules/@types/react/index.d.ts:1536


        Optional onAnimationEndCapture#

        onAnimationEndCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1535

        +

        Defined in node_modules/@types/react/index.d.ts:1537


        Optional onAnimationIteration#

        onAnimationIteration? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationIteration

        -

        Defined in node_modules/@types/react/index.d.ts:1536

        +

        Defined in node_modules/@types/react/index.d.ts:1538


        Optional onAnimationIterationCapture#

        onAnimationIterationCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationIterationCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1537

        +

        Defined in node_modules/@types/react/index.d.ts:1539


        Optional onAnimationStart#

        onAnimationStart? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationStart

        -

        Defined in node_modules/@types/react/index.d.ts:1532

        +

        Defined in node_modules/@types/react/index.d.ts:1534


        Optional onAnimationStartCapture#

        onAnimationStartCapture? : AnimationEventHandler‹any›

        Inherited from PageLayoutProps.onAnimationStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1533

        +

        Defined in node_modules/@types/react/index.d.ts:1535


        Optional onAuxClick#

        onAuxClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onAuxClick

        -

        Defined in node_modules/@types/react/index.d.ts:1450

        +

        Defined in node_modules/@types/react/index.d.ts:1452


        Optional onAuxClickCapture#

        onAuxClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onAuxClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1451

        +

        Defined in node_modules/@types/react/index.d.ts:1453


        Optional onBeforeInput#

        onBeforeInput? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onBeforeInput

        -

        Defined in node_modules/@types/react/index.d.ts:1378

        +

        Defined in node_modules/@types/react/index.d.ts:1380


        Optional onBeforeInputCapture#

        onBeforeInputCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onBeforeInputCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1379

        +

        Defined in node_modules/@types/react/index.d.ts:1381


        Optional onBlur#

        onBlur? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onBlur

        -

        Defined in node_modules/@types/react/index.d.ts:1372

        +

        Defined in node_modules/@types/react/index.d.ts:1374


        Optional onBlurCapture#

        onBlurCapture? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onBlurCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1373

        +

        Defined in node_modules/@types/react/index.d.ts:1375


        Optional onCanPlay#

        onCanPlay? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlay

        -

        Defined in node_modules/@types/react/index.d.ts:1406

        +

        Defined in node_modules/@types/react/index.d.ts:1408


        Optional onCanPlayCapture#

        onCanPlayCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1407

        +

        Defined in node_modules/@types/react/index.d.ts:1409


        Optional onCanPlayThrough#

        onCanPlayThrough? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayThrough

        -

        Defined in node_modules/@types/react/index.d.ts:1408

        +

        Defined in node_modules/@types/react/index.d.ts:1410


        Optional onCanPlayThroughCapture#

        onCanPlayThroughCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onCanPlayThroughCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1409

        +

        Defined in node_modules/@types/react/index.d.ts:1411


        Optional onChange#

        onChange? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onChange

        -

        Defined in node_modules/@types/react/index.d.ts:1376

        +

        Defined in node_modules/@types/react/index.d.ts:1378


        Optional onChangeCapture#

        onChangeCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1377

        +

        Defined in node_modules/@types/react/index.d.ts:1379


        Optional onClick#

        onClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onClick

        -

        Defined in node_modules/@types/react/index.d.ts:1452

        +

        Defined in node_modules/@types/react/index.d.ts:1454


        Optional onClickCapture#

        onClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1453

        +

        Defined in node_modules/@types/react/index.d.ts:1455


        Optional onCompositionEnd#

        onCompositionEnd? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1362

        +

        Defined in node_modules/@types/react/index.d.ts:1364


        Optional onCompositionEndCapture#

        onCompositionEndCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1363

        +

        Defined in node_modules/@types/react/index.d.ts:1365


        Optional onCompositionStart#

        onCompositionStart? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionStart

        -

        Defined in node_modules/@types/react/index.d.ts:1364

        +

        Defined in node_modules/@types/react/index.d.ts:1366


        Optional onCompositionStartCapture#

        onCompositionStartCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1365

        +

        Defined in node_modules/@types/react/index.d.ts:1367


        Optional onCompositionUpdate#

        onCompositionUpdate? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionUpdate

        -

        Defined in node_modules/@types/react/index.d.ts:1366

        +

        Defined in node_modules/@types/react/index.d.ts:1368


        Optional onCompositionUpdateCapture#

        onCompositionUpdateCapture? : CompositionEventHandler‹any›

        Inherited from PageLayoutProps.onCompositionUpdateCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1367

        +

        Defined in node_modules/@types/react/index.d.ts:1369


        Optional onContextMenu#

        onContextMenu? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onContextMenu

        -

        Defined in node_modules/@types/react/index.d.ts:1454

        +

        Defined in node_modules/@types/react/index.d.ts:1456


        Optional onContextMenuCapture#

        onContextMenuCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onContextMenuCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1455

        +

        Defined in node_modules/@types/react/index.d.ts:1457


        Optional onCopy#

        onCopy? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCopy

        -

        Defined in node_modules/@types/react/index.d.ts:1354

        +

        Defined in node_modules/@types/react/index.d.ts:1356


        Optional onCopyCapture#

        onCopyCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCopyCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1355

        +

        Defined in node_modules/@types/react/index.d.ts:1357


        Optional onCut#

        onCut? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCut

        -

        Defined in node_modules/@types/react/index.d.ts:1356

        +

        Defined in node_modules/@types/react/index.d.ts:1358


        Optional onCutCapture#

        onCutCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onCutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1357

        +

        Defined in node_modules/@types/react/index.d.ts:1359


        Optional onDoubleClick#

        onDoubleClick? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onDoubleClick

        -

        Defined in node_modules/@types/react/index.d.ts:1456

        +

        Defined in node_modules/@types/react/index.d.ts:1458


        Optional onDoubleClickCapture#

        onDoubleClickCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onDoubleClickCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1457

        +

        Defined in node_modules/@types/react/index.d.ts:1459


        Optional onDrag#

        onDrag? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDrag

        -

        Defined in node_modules/@types/react/index.d.ts:1458

        +

        Defined in node_modules/@types/react/index.d.ts:1460


        Optional onDragCapture#

        onDragCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1459

        +

        Defined in node_modules/@types/react/index.d.ts:1461


        Optional onDragEnd#

        onDragEnd? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1460

        +

        Defined in node_modules/@types/react/index.d.ts:1462


        Optional onDragEndCapture#

        onDragEndCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1461

        +

        Defined in node_modules/@types/react/index.d.ts:1463


        Optional onDragEnter#

        onDragEnter? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1462

        +

        Defined in node_modules/@types/react/index.d.ts:1464


        Optional onDragEnterCapture#

        onDragEnterCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragEnterCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1463

        +

        Defined in node_modules/@types/react/index.d.ts:1465


        Optional onDragExit#

        onDragExit? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragExit

        -

        Defined in node_modules/@types/react/index.d.ts:1464

        +

        Defined in node_modules/@types/react/index.d.ts:1466


        Optional onDragExitCapture#

        onDragExitCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragExitCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1465

        +

        Defined in node_modules/@types/react/index.d.ts:1467


        Optional onDragLeave#

        onDragLeave? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1466

        +

        Defined in node_modules/@types/react/index.d.ts:1468


        Optional onDragLeaveCapture#

        onDragLeaveCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragLeaveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1467

        +

        Defined in node_modules/@types/react/index.d.ts:1469


        Optional onDragOver#

        onDragOver? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragOver

        -

        Defined in node_modules/@types/react/index.d.ts:1468

        +

        Defined in node_modules/@types/react/index.d.ts:1470


        Optional onDragOverCapture#

        onDragOverCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1469

        +

        Defined in node_modules/@types/react/index.d.ts:1471


        Optional onDragStart#

        onDragStart? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragStart

        -

        Defined in node_modules/@types/react/index.d.ts:1470

        +

        Defined in node_modules/@types/react/index.d.ts:1472


        Optional onDragStartCapture#

        onDragStartCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDragStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1471

        +

        Defined in node_modules/@types/react/index.d.ts:1473


        Optional onDrop#

        onDrop? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDrop

        -

        Defined in node_modules/@types/react/index.d.ts:1472

        +

        Defined in node_modules/@types/react/index.d.ts:1474


        Optional onDropCapture#

        onDropCapture? : DragEventHandler‹any›

        Inherited from PageLayoutProps.onDropCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1473

        +

        Defined in node_modules/@types/react/index.d.ts:1475


        Optional onDurationChange#

        onDurationChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onDurationChange

        -

        Defined in node_modules/@types/react/index.d.ts:1410

        +

        Defined in node_modules/@types/react/index.d.ts:1412


        Optional onDurationChangeCapture#

        onDurationChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onDurationChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1411

        +

        Defined in node_modules/@types/react/index.d.ts:1413


        Optional onEmptied#

        onEmptied? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEmptied

        -

        Defined in node_modules/@types/react/index.d.ts:1412

        +

        Defined in node_modules/@types/react/index.d.ts:1414


        Optional onEmptiedCapture#

        onEmptiedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEmptiedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1413

        +

        Defined in node_modules/@types/react/index.d.ts:1415


        Optional onEncrypted#

        onEncrypted? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEncrypted

        -

        Defined in node_modules/@types/react/index.d.ts:1414

        +

        Defined in node_modules/@types/react/index.d.ts:1416


        Optional onEncryptedCapture#

        onEncryptedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEncryptedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1415

        +

        Defined in node_modules/@types/react/index.d.ts:1417


        Optional onEnded#

        onEnded? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEnded

        -

        Defined in node_modules/@types/react/index.d.ts:1416

        +

        Defined in node_modules/@types/react/index.d.ts:1418


        Optional onEndedCapture#

        onEndedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onEndedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1417

        +

        Defined in node_modules/@types/react/index.d.ts:1419


        Optional onError#

        onError? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onError

        -

        Defined in node_modules/@types/react/index.d.ts:1392

        +

        Defined in node_modules/@types/react/index.d.ts:1394


        Optional onErrorCapture#

        onErrorCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onErrorCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1393

        +

        Defined in node_modules/@types/react/index.d.ts:1395


        Optional onFocus#

        onFocus? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onFocus

        -

        Defined in node_modules/@types/react/index.d.ts:1370

        +

        Defined in node_modules/@types/react/index.d.ts:1372


        Optional onFocusCapture#

        onFocusCapture? : FocusEventHandler‹any›

        Inherited from PageLayoutProps.onFocusCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1371

        +

        Defined in node_modules/@types/react/index.d.ts:1373


        Optional onGotPointerCapture#

        onGotPointerCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onGotPointerCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1518

        +

        Defined in node_modules/@types/react/index.d.ts:1520


        Optional onGotPointerCaptureCapture#

        onGotPointerCaptureCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onGotPointerCaptureCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1519

        +

        Defined in node_modules/@types/react/index.d.ts:1521


        Optional onInput#

        onInput? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInput

        -

        Defined in node_modules/@types/react/index.d.ts:1380

        +

        Defined in node_modules/@types/react/index.d.ts:1382


        Optional onInputCapture#

        onInputCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInputCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1381

        +

        Defined in node_modules/@types/react/index.d.ts:1383


        Optional onInvalid#

        onInvalid? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInvalid

        -

        Defined in node_modules/@types/react/index.d.ts:1386

        +

        Defined in node_modules/@types/react/index.d.ts:1388


        Optional onInvalidCapture#

        onInvalidCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onInvalidCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1387

        +

        Defined in node_modules/@types/react/index.d.ts:1389


        Optional onKeyDown#

        onKeyDown? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyDown

        -

        Defined in node_modules/@types/react/index.d.ts:1396

        +

        Defined in node_modules/@types/react/index.d.ts:1398


        Optional onKeyDownCapture#

        onKeyDownCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1397

        +

        Defined in node_modules/@types/react/index.d.ts:1399


        Optional onKeyPress#

        onKeyPress? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyPress

        -

        Defined in node_modules/@types/react/index.d.ts:1398

        +

        Defined in node_modules/@types/react/index.d.ts:1400


        Optional onKeyPressCapture#

        onKeyPressCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyPressCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1399

        +

        Defined in node_modules/@types/react/index.d.ts:1401


        Optional onKeyUp#

        onKeyUp? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyUp

        -

        Defined in node_modules/@types/react/index.d.ts:1400

        +

        Defined in node_modules/@types/react/index.d.ts:1402


        Optional onKeyUpCapture#

        onKeyUpCapture? : KeyboardEventHandler‹any›

        Inherited from PageLayoutProps.onKeyUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1401

        +

        Defined in node_modules/@types/react/index.d.ts:1403


        Optional onLoad#

        onLoad? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoad

        -

        Defined in node_modules/@types/react/index.d.ts:1390

        +

        Defined in node_modules/@types/react/index.d.ts:1392


        Optional onLoadCapture#

        onLoadCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1391

        +

        Defined in node_modules/@types/react/index.d.ts:1393


        Optional onLoadStart#

        onLoadStart? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadStart

        -

        Defined in node_modules/@types/react/index.d.ts:1422

        +

        Defined in node_modules/@types/react/index.d.ts:1424


        Optional onLoadStartCapture#

        onLoadStartCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1423

        +

        Defined in node_modules/@types/react/index.d.ts:1425


        Optional onLoadedData#

        onLoadedData? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedData

        -

        Defined in node_modules/@types/react/index.d.ts:1418

        +

        Defined in node_modules/@types/react/index.d.ts:1420


        Optional onLoadedDataCapture#

        onLoadedDataCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedDataCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1419

        +

        Defined in node_modules/@types/react/index.d.ts:1421


        Optional onLoadedMetadata#

        onLoadedMetadata? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedMetadata

        -

        Defined in node_modules/@types/react/index.d.ts:1420

        +

        Defined in node_modules/@types/react/index.d.ts:1422


        Optional onLoadedMetadataCapture#

        onLoadedMetadataCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onLoadedMetadataCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1421

        +

        Defined in node_modules/@types/react/index.d.ts:1423


        Optional onLostPointerCapture#

        onLostPointerCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onLostPointerCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1520

        +

        Defined in node_modules/@types/react/index.d.ts:1522


        Optional onLostPointerCaptureCapture#

        onLostPointerCaptureCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onLostPointerCaptureCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1521

        +

        Defined in node_modules/@types/react/index.d.ts:1523


        Optional onMouseDown#

        onMouseDown? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseDown

        -

        Defined in node_modules/@types/react/index.d.ts:1474

        +

        Defined in node_modules/@types/react/index.d.ts:1476


        Optional onMouseDownCapture#

        onMouseDownCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1475

        +

        Defined in node_modules/@types/react/index.d.ts:1477


        Optional onMouseEnter#

        onMouseEnter? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1476

        +

        Defined in node_modules/@types/react/index.d.ts:1478


        Optional onMouseLeave#

        onMouseLeave? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1477

        +

        Defined in node_modules/@types/react/index.d.ts:1479


        Optional onMouseMove#

        onMouseMove? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseMove

        -

        Defined in node_modules/@types/react/index.d.ts:1478

        +

        Defined in node_modules/@types/react/index.d.ts:1480


        Optional onMouseMoveCapture#

        onMouseMoveCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1479

        +

        Defined in node_modules/@types/react/index.d.ts:1481


        Optional onMouseOut#

        onMouseOut? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOut

        -

        Defined in node_modules/@types/react/index.d.ts:1480

        +

        Defined in node_modules/@types/react/index.d.ts:1482


        Optional onMouseOutCapture#

        onMouseOutCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1481

        +

        Defined in node_modules/@types/react/index.d.ts:1483


        Optional onMouseOver#

        onMouseOver? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOver

        -

        Defined in node_modules/@types/react/index.d.ts:1482

        +

        Defined in node_modules/@types/react/index.d.ts:1484


        Optional onMouseOverCapture#

        onMouseOverCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1483

        +

        Defined in node_modules/@types/react/index.d.ts:1485


        Optional onMouseUp#

        onMouseUp? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseUp

        -

        Defined in node_modules/@types/react/index.d.ts:1484

        +

        Defined in node_modules/@types/react/index.d.ts:1486


        Optional onMouseUpCapture#

        onMouseUpCapture? : MouseEventHandler‹any›

        Inherited from PageLayoutProps.onMouseUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1485

        +

        Defined in node_modules/@types/react/index.d.ts:1487


        Optional onPaste#

        onPaste? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onPaste

        -

        Defined in node_modules/@types/react/index.d.ts:1358

        +

        Defined in node_modules/@types/react/index.d.ts:1360


        Optional onPasteCapture#

        onPasteCapture? : ClipboardEventHandler‹any›

        Inherited from PageLayoutProps.onPasteCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1359

        +

        Defined in node_modules/@types/react/index.d.ts:1361


        Optional onPause#

        onPause? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPause

        -

        Defined in node_modules/@types/react/index.d.ts:1424

        +

        Defined in node_modules/@types/react/index.d.ts:1426


        Optional onPauseCapture#

        onPauseCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPauseCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1425

        +

        Defined in node_modules/@types/react/index.d.ts:1427


        Optional onPlay#

        onPlay? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlay

        -

        Defined in node_modules/@types/react/index.d.ts:1426

        +

        Defined in node_modules/@types/react/index.d.ts:1428


        Optional onPlayCapture#

        onPlayCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlayCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1427

        +

        Defined in node_modules/@types/react/index.d.ts:1429


        Optional onPlaying#

        onPlaying? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlaying

        -

        Defined in node_modules/@types/react/index.d.ts:1428

        +

        Defined in node_modules/@types/react/index.d.ts:1430


        Optional onPlayingCapture#

        onPlayingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onPlayingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1429

        +

        Defined in node_modules/@types/react/index.d.ts:1431


        Optional onPointerCancel#

        onPointerCancel? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerCancel

        -

        Defined in node_modules/@types/react/index.d.ts:1508

        +

        Defined in node_modules/@types/react/index.d.ts:1510


        Optional onPointerCancelCapture#

        onPointerCancelCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerCancelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1509

        +

        Defined in node_modules/@types/react/index.d.ts:1511


        Optional onPointerDown#

        onPointerDown? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerDown

        -

        Defined in node_modules/@types/react/index.d.ts:1502

        +

        Defined in node_modules/@types/react/index.d.ts:1504


        Optional onPointerDownCapture#

        onPointerDownCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerDownCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1503

        +

        Defined in node_modules/@types/react/index.d.ts:1505


        Optional onPointerEnter#

        onPointerEnter? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerEnter

        -

        Defined in node_modules/@types/react/index.d.ts:1510

        +

        Defined in node_modules/@types/react/index.d.ts:1512


        Optional onPointerEnterCapture#

        onPointerEnterCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerEnterCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1511

        +

        Defined in node_modules/@types/react/index.d.ts:1513


        Optional onPointerLeave#

        onPointerLeave? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerLeave

        -

        Defined in node_modules/@types/react/index.d.ts:1512

        +

        Defined in node_modules/@types/react/index.d.ts:1514


        Optional onPointerLeaveCapture#

        onPointerLeaveCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerLeaveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1513

        +

        Defined in node_modules/@types/react/index.d.ts:1515


        Optional onPointerMove#

        onPointerMove? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerMove

        -

        Defined in node_modules/@types/react/index.d.ts:1504

        +

        Defined in node_modules/@types/react/index.d.ts:1506


        Optional onPointerMoveCapture#

        onPointerMoveCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1505

        +

        Defined in node_modules/@types/react/index.d.ts:1507


        Optional onPointerOut#

        onPointerOut? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOut

        -

        Defined in node_modules/@types/react/index.d.ts:1516

        +

        Defined in node_modules/@types/react/index.d.ts:1518


        Optional onPointerOutCapture#

        onPointerOutCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOutCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1517

        +

        Defined in node_modules/@types/react/index.d.ts:1519


        Optional onPointerOver#

        onPointerOver? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOver

        -

        Defined in node_modules/@types/react/index.d.ts:1514

        +

        Defined in node_modules/@types/react/index.d.ts:1516


        Optional onPointerOverCapture#

        onPointerOverCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerOverCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1515

        +

        Defined in node_modules/@types/react/index.d.ts:1517


        Optional onPointerUp#

        onPointerUp? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerUp

        -

        Defined in node_modules/@types/react/index.d.ts:1506

        +

        Defined in node_modules/@types/react/index.d.ts:1508


        Optional onPointerUpCapture#

        onPointerUpCapture? : PointerEventHandler‹any›

        Inherited from PageLayoutProps.onPointerUpCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1507

        +

        Defined in node_modules/@types/react/index.d.ts:1509


        Optional onProgress#

        onProgress? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onProgress

        -

        Defined in node_modules/@types/react/index.d.ts:1430

        +

        Defined in node_modules/@types/react/index.d.ts:1432


        Optional onProgressCapture#

        onProgressCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onProgressCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1431

        +

        Defined in node_modules/@types/react/index.d.ts:1433


        Optional onRateChange#

        onRateChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onRateChange

        -

        Defined in node_modules/@types/react/index.d.ts:1432

        +

        Defined in node_modules/@types/react/index.d.ts:1434


        Optional onRateChangeCapture#

        onRateChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onRateChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1433

        +

        Defined in node_modules/@types/react/index.d.ts:1435


        Optional onReset#

        onReset? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onReset

        -

        Defined in node_modules/@types/react/index.d.ts:1382

        +

        Defined in node_modules/@types/react/index.d.ts:1384


        Optional onResetCapture#

        onResetCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onResetCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1383

        +

        Defined in node_modules/@types/react/index.d.ts:1385


        Optional onScroll#

        onScroll? : UIEventHandler‹any›

        Inherited from PageLayoutProps.onScroll

        -

        Defined in node_modules/@types/react/index.d.ts:1524

        +

        Defined in node_modules/@types/react/index.d.ts:1526


        Optional onScrollCapture#

        onScrollCapture? : UIEventHandler‹any›

        Inherited from PageLayoutProps.onScrollCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1525

        +

        Defined in node_modules/@types/react/index.d.ts:1527


        Optional onSeeked#

        onSeeked? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeeked

        -

        Defined in node_modules/@types/react/index.d.ts:1434

        +

        Defined in node_modules/@types/react/index.d.ts:1436


        Optional onSeekedCapture#

        onSeekedCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeekedCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1435

        +

        Defined in node_modules/@types/react/index.d.ts:1437


        Optional onSeeking#

        onSeeking? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeeking

        -

        Defined in node_modules/@types/react/index.d.ts:1436

        +

        Defined in node_modules/@types/react/index.d.ts:1438


        Optional onSeekingCapture#

        onSeekingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSeekingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1437

        +

        Defined in node_modules/@types/react/index.d.ts:1439


        Optional onSelect#

        onSelect? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSelect

        -

        Defined in node_modules/@types/react/index.d.ts:1488

        +

        Defined in node_modules/@types/react/index.d.ts:1490


        Optional onSelectCapture#

        onSelectCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSelectCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1489

        +

        Defined in node_modules/@types/react/index.d.ts:1491


        Optional onStalled#

        onStalled? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onStalled

        -

        Defined in node_modules/@types/react/index.d.ts:1438

        +

        Defined in node_modules/@types/react/index.d.ts:1440


        Optional onStalledCapture#

        onStalledCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onStalledCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1439

        +

        Defined in node_modules/@types/react/index.d.ts:1441


        Optional onSubmit#

        onSubmit? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onSubmit

        -

        Defined in node_modules/@types/react/index.d.ts:1384

        +

        Defined in node_modules/@types/react/index.d.ts:1386


        Optional onSubmitCapture#

        onSubmitCapture? : FormEventHandler‹any›

        Inherited from PageLayoutProps.onSubmitCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1385

        +

        Defined in node_modules/@types/react/index.d.ts:1387


        Optional onSuspend#

        onSuspend? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSuspend

        -

        Defined in node_modules/@types/react/index.d.ts:1440

        +

        Defined in node_modules/@types/react/index.d.ts:1442


        Optional onSuspendCapture#

        onSuspendCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onSuspendCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1441

        +

        Defined in node_modules/@types/react/index.d.ts:1443


        Optional onTimeUpdate#

        onTimeUpdate? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onTimeUpdate

        -

        Defined in node_modules/@types/react/index.d.ts:1442

        +

        Defined in node_modules/@types/react/index.d.ts:1444


        Optional onTimeUpdateCapture#

        onTimeUpdateCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onTimeUpdateCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1443

        +

        Defined in node_modules/@types/react/index.d.ts:1445


        Optional onTouchCancel#

        onTouchCancel? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchCancel

        -

        Defined in node_modules/@types/react/index.d.ts:1492

        +

        Defined in node_modules/@types/react/index.d.ts:1494


        Optional onTouchCancelCapture#

        onTouchCancelCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchCancelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1493

        +

        Defined in node_modules/@types/react/index.d.ts:1495


        Optional onTouchEnd#

        onTouchEnd? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1494

        +

        Defined in node_modules/@types/react/index.d.ts:1496


        Optional onTouchEndCapture#

        onTouchEndCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1495

        +

        Defined in node_modules/@types/react/index.d.ts:1497


        Optional onTouchMove#

        onTouchMove? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchMove

        -

        Defined in node_modules/@types/react/index.d.ts:1496

        +

        Defined in node_modules/@types/react/index.d.ts:1498


        Optional onTouchMoveCapture#

        onTouchMoveCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchMoveCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1497

        +

        Defined in node_modules/@types/react/index.d.ts:1499


        Optional onTouchStart#

        onTouchStart? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchStart

        -

        Defined in node_modules/@types/react/index.d.ts:1498

        +

        Defined in node_modules/@types/react/index.d.ts:1500


        Optional onTouchStartCapture#

        onTouchStartCapture? : TouchEventHandler‹any›

        Inherited from PageLayoutProps.onTouchStartCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1499

        +

        Defined in node_modules/@types/react/index.d.ts:1501


        Optional onTransitionEnd#

        onTransitionEnd? : TransitionEventHandler‹any›

        Inherited from PageLayoutProps.onTransitionEnd

        -

        Defined in node_modules/@types/react/index.d.ts:1540

        +

        Defined in node_modules/@types/react/index.d.ts:1542


        Optional onTransitionEndCapture#

        onTransitionEndCapture? : TransitionEventHandler‹any›

        Inherited from PageLayoutProps.onTransitionEndCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1541

        +

        Defined in node_modules/@types/react/index.d.ts:1543


        Optional onVolumeChange#

        onVolumeChange? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onVolumeChange

        -

        Defined in node_modules/@types/react/index.d.ts:1444

        +

        Defined in node_modules/@types/react/index.d.ts:1446


        Optional onVolumeChangeCapture#

        onVolumeChangeCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onVolumeChangeCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1445

        +

        Defined in node_modules/@types/react/index.d.ts:1447


        Optional onWaiting#

        onWaiting? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onWaiting

        -

        Defined in node_modules/@types/react/index.d.ts:1446

        +

        Defined in node_modules/@types/react/index.d.ts:1448


        Optional onWaitingCapture#

        onWaitingCapture? : ReactEventHandler‹any›

        Inherited from PageLayoutProps.onWaitingCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1447

        +

        Defined in node_modules/@types/react/index.d.ts:1449


        Optional onWheel#

        onWheel? : WheelEventHandler‹any›

        Inherited from PageLayoutProps.onWheel

        -

        Defined in node_modules/@types/react/index.d.ts:1528

        +

        Defined in node_modules/@types/react/index.d.ts:1530


        Optional onWheelCapture#

        onWheelCapture? : WheelEventHandler‹any›

        Inherited from PageLayoutProps.onWheelCapture

        -

        Defined in node_modules/@types/react/index.d.ts:1529

        +

        Defined in node_modules/@types/react/index.d.ts:1531

        diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html new file mode 100644 index 0000000000..a7fcd9872c --- /dev/null +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html @@ -0,0 +1,1117 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + +
        + + + +
        + +
        + +
        + + + + +
        +
        + + +
        +
        +
        + + + +
        +
        +
        + + + + + + + +
        +
        +
        + + +
        +
        +
        + + + +
        +
        + + + +

        Interface: WizardProps ‹D#

        +

        Type parameters#

        +

        D

        +

        Hierarchy#

        +
          +
        • WizardCommonProps
        • +
        +

        WizardProps

        +

        Index#

        +

        Properties#

        + +

        Properties#

        +

        Optional className#

        +

        className? : string

        +

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

        +
        +

        Optional data#

        +

        data? : Partial‹D›

        +

        Inherited from WizardProps.data

        +

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

        +
        +

        Optional done#

        +

        done? : function

        +

        Inherited from WizardProps.done

        +

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

        +

        Type declaration:

        +

        ▸ (): void

        +
        +

        Optional header#

        +

        header? : React.ReactNode

        +

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

        +
        +

        Optional hideSteps#

        +

        hideSteps? : boolean

        +

        Inherited from WizardProps.hideSteps

        +

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

        +
        +

        Optional onChange#

        +

        onChange? : function

        +

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

        +

        Type declaration:

        +

        ▸ (step: number): void

        +

        Parameters:

        +
      + + + + + + + + + + + + +
      NameType
      stepnumber
      +
      +

      Optional reset#

      +

      reset? : function

      +

      Inherited from WizardProps.reset

      +

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

      +

      Type declaration:

      +

      ▸ (): void

      +
      +

      Optional save#

      +

      save? : function

      +

      Inherited from WizardProps.save

      +

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

      +

      Type declaration:

      +

      ▸ (data: Partial‹D›, callback?: function): void

      +

      Parameters:

      +

      data: Partial‹D›

      +

      Optional callback: function

      +

      ▸ (): void

      +
      +

      Optional step#

      +

      step? : number

      +

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

      +
      +

      Optional title#

      +

      title? : string

      +

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

      + + + + + + + + +
    +
    + + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html new file mode 100644 index 0000000000..fe88f29730 --- /dev/null +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html @@ -0,0 +1,1352 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardStepProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Interface: WizardStepProps ‹D#

    +

    Type parameters#

    +

    D

    +

    Hierarchy#

    +
      +
    • WizardCommonProps‹D›
    • +
    +

    WizardStepProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional afterContent#

    +

    afterContent? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:122

    +
    +

    Optional beforeContent#

    +

    beforeContent? : React.ReactNode

    +

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

    +
    +

    Optional className#

    +

    className? : string | object

    +

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

    +
    +

    Optional contentClass#

    +

    contentClass? : string | object

    +

    Defined in src/renderer/components/wizard/wizard.tsx:104

    +
    +

    Optional customButtons#

    +

    customButtons? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:105

    +
    +

    Optional data#

    +

    data? : Partial‹D›

    +

    Inherited from WizardProps.data

    +

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

    +
    +

    Optional disabledNext#

    +

    disabledNext? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:109

    +
    +

    Optional done#

    +

    done? : function

    +

    Inherited from WizardProps.done

    +

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

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional first#

    +

    first? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:117

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional hideBackBtn#

    +

    hideBackBtn? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:111

    +
    +

    Optional hideNextBtn#

    +

    hideNextBtn? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:110

    +
    +

    Optional hideSteps#

    +

    hideSteps? : boolean

    +

    Inherited from WizardProps.hideSteps

    +

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

    +
    +

    Optional isFirst#

    +

    isFirst? : function

    +

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

    +

    Type declaration:

    +

    ▸ (): boolean

    +
    +

    Optional isLast#

    +

    isLast? : function

    +

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

    +

    Type declaration:

    +

    ▸ (): boolean

    +
    +

    Optional last#

    +

    last? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:118

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional loading#

    +

    loading? : boolean

    +

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

    +
    +

    Optional moreButtons#

    +

    moreButtons? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:106

    +
    +

    Optional next#

    +

    next? : function

    +

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

    +

    Type declaration:

    +

    ▸ (): void | boolean | Promise‹any›

    +
    +

    Optional nextLabel#

    +

    nextLabel? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:114

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:123

    +
    +

    Optional prev#

    +

    prev? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:116

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional prevLabel#

    +

    prevLabel? : React.ReactNode

    +

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

    +
    +

    Optional reset#

    +

    reset? : function

    +

    Inherited from WizardProps.reset

    +

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

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional save#

    +

    save? : function

    +

    Inherited from WizardProps.save

    +

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

    +

    Type declaration:

    +

    ▸ (data: Partial‹D›, callback?: function): void

    +

    Parameters:

    +

    data: Partial‹D›

    +

    Optional callback: function

    +

    ▸ (): void

    +
    +

    Optional scrollable#

    +

    scrollable? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:125

    +
    +

    Optional skip#

    +

    skip? : boolean

    +

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

    +
    +

    Optional step#

    +

    step? : number

    +

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

    +
    +

    Optional title#

    +

    title? : string

    +

    Defined in src/renderer/components/wizard/wizard.tsx:102

    +
    +

    Optional waiting#

    +

    waiting? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:108

    +
    +

    Optional wizard#

    +

    wizard? : Wizard

    +

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

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file 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 fa3dd988fd..df8a1398ba 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -887,7 +887,7 @@

    Properties#

    id#

    id: string

    -

    Defined in src/renderer/api/kube-api.ts:63

    +

    Defined in src/renderer/api/kube-api.ts:65

    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 e59571286b..02d0e2ce3c 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 @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -905,8 +905,8 @@
  • - - ports + + Optional ports
  • @@ -923,6 +923,13 @@ Optional resources + + +
  • + + Optional startupProbe + +
  • @@ -967,55 +974,56 @@
  • imagePullPolicy
  • livenessProbe
  • name
  • -
  • ports
  • +
  • ports
  • readinessProbe
  • resources
  • +
  • startupProbe
  • volumeMounts
  • 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:119


    Optional livenessProbe#

    livenessProbe? : IContainerProbe

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:113

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:116


    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

    +

    Optional 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

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:117


    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:

    • @@ -1038,9 +1046,13 @@

    +

    Optional startupProbe#

    +

    startupProbe? : IContainerProbe

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:118

    +

    Optional volumeMounts#

    volumeMounts? : object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:108

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:111

    diff --git a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html index 174f9506b9..af00787afb 100644 --- a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html @@ -598,7 +598,7 @@
  • - Working with mobx + Working with MobX
  • @@ -849,8 +849,8 @@
    • - - containerID + + Optional containerID
    • @@ -870,8 +870,8 @@
    • - - lastState + + Optional lastState
    • @@ -898,8 +898,15 @@
    • - - state + + Optional started + + +
    • + +
    • + + Optional state
    • @@ -931,41 +938,45 @@

      Index#

      Properties#

      Properties#

      -

      containerID#

      -

      containerID: string

      -

      Defined in src/renderer/api/endpoints/pods.api.ts:170

      +

      Optional containerID#

      +

      containerID? : string

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:180


      image#

      image: string

      -

      Defined in src/renderer/api/endpoints/pods.api.ts:168

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:178


      imageID#

      imageID: string

      -

      Defined in src/renderer/api/endpoints/pods.api.ts:169

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:179


      -

      lastState#

      -

      lastState: object

      -

      Defined in src/renderer/api/endpoints/pods.api.ts:156

      +

      Optional lastState#

      +

      lastState? : object

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:160

      Type declaration:

      • [ index: string]: object

      • -

        terminated(): object

        +

        running(): object

      • -

        containerID: string

        +

        startedAt: string

        +
      • +
      • +

        terminated(): object

      • exitCode: number

        @@ -979,23 +990,36 @@
      • startedAt: string

      • +
      • +

        waiting(): object

        +
      • +
      • +

        message: string

        +
      • +
      • +

        reason: string

        +

      name#

      name: string

      -

      Defined in src/renderer/api/endpoints/pods.api.ts:139

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:143


      ready#

      ready: boolean

      -

      Defined in src/renderer/api/endpoints/pods.api.ts:166

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:176


      restartCount#

      restartCount: number

      -

      Defined in src/renderer/api/endpoints/pods.api.ts:167

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:177


      -

      state#

      -

      state: object

      -

      Defined in src/renderer/api/endpoints/pods.api.ts:140

      +

      Optional started#

      +

      started? : boolean

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:181

      +
      +

      Optional state#

      +

      state? : object

      +

      Defined in src/renderer/api/endpoints/pods.api.ts:144

      Type declaration:

      • diff --git a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html index c9e6313250..312c61762a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -895,11 +895,11 @@

        Properties#

        Optional key#

        key? : string

        -

        Defined in src/renderer/api/endpoints/secret.api.ts:18

        +

        Defined in src/renderer/api/endpoints/secret.api.ts:18


        name#

        name: string

        -

        Defined in src/renderer/api/endpoints/secret.api.ts:19

        +

        Defined in src/renderer/api/endpoints/secret.api.ts:19

        diff --git a/latest/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html b/latest/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html index 8771027978..d86614bda6 100644 --- a/latest/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -905,11 +905,11 @@

        Properties#

        Optional params#

        params? : P

        -

        Defined in src/common/utils/buildUrl.ts:4

        +

        Defined in src/common/utils/buildUrl.ts:4


        Optional query#

        query? : Q

        -

        Defined in src/common/utils/buildUrl.ts:5

        +

        Defined in src/common/utils/buildUrl.ts:5

        diff --git a/latest/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html b/latest/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html new file mode 100644 index 0000000000..e8fd9c4944 --- /dev/null +++ b/latest/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html @@ -0,0 +1,1115 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageParamInit ‹**V**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        + +
        + + + +
        + +
        + +
        + + + + +
        +
        + + +
        +
        +
        + + + +
        +
        +
        + + + + + + + +
        +
        +
        + + +
        +
        +
        + + + +
        +
        + + + +

        Interface: PageParamInit ‹V#

        +

        Type parameters#

        +

        V

        +

        Hierarchy#

        +
          +
        • PageParamInit
        • +
        +

        Index#

        +

        Properties#

        + +

        Methods#

        + +

        Properties#

        +

        Optional defaultValue#

        +

        defaultValue? : V

        +

        Defined in src/renderer/navigation/page-param.ts:6

        +
        +

        Optional defaultValueStringified#

        +

        defaultValueStringified? : string | string[]

        +

        Defined in src/renderer/navigation/page-param.ts:7

        +
        +

        Optional multiValueSep#

        +

        multiValueSep? : string

        +

        Defined in src/renderer/navigation/page-param.ts:9

        +
        +

        Optional multiValues#

        +

        multiValues? : boolean

        +

        Defined in src/renderer/navigation/page-param.ts:8

        +
        +

        name#

        +

        name: string

        +

        Defined in src/renderer/navigation/page-param.ts:5

        +
        +

        Optional skipEmpty#

        +

        skipEmpty? : boolean

        +

        Defined in src/renderer/navigation/page-param.ts:10

        +

        Methods#

        +

        Optional parse#

        +

        parse(value: string[]): V

        +

        Defined in src/renderer/navigation/page-param.ts:11

        +

        Parameters:

        + + + + + + + + + + + + + +
        NameType
        valuestring[]
        +

        Returns: V

        +
        +

        Optional stringify#

        +

        stringify(value: V): string | string[]

        +

        Defined in src/renderer/navigation/page-param.ts:12

        +

        Parameters:

        + + + + + + + + + + + + + +
        NameType
        valueV
        +

        Returns: string | string[]

        + + + + + + + +
        +
        +
        +
        + + + + +
        + + + + + + + + + \ No newline at end of file diff --git a/latest/extensions/api/modules/_core_api_app_/index.html b/latest/extensions/api/modules/_core_api_app_/index.html index b4c617be3f..abd9fc7142 100644 --- a/latest/extensions/api/modules/_core_api_app_/index.html +++ b/latest/extensions/api/modules/_core_api_app_/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -963,39 +963,39 @@

        Variables#

        Const appName#

        appName: string = ${packageInfo.productName}${isDevelopment ? "Dev" : ""}

        -

        Defined in src/common/vars.ts:15

        +

        Defined in src/common/vars.ts:15


        Const isLinux#

        isLinux: boolean = process.platform === "linux"

        -

        Defined in src/common/vars.ts:8

        +

        Defined in src/common/vars.ts:8


        Const isMac#

        isMac: boolean = process.platform === "darwin"

        -

        Defined in src/common/vars.ts:6

        +

        Defined in src/common/vars.ts:6


        Const isSnap#

        isSnap: boolean = !!process.env.SNAP

        -

        Defined in src/common/vars.ts:10

        +

        Defined in src/common/vars.ts:10


        Const isWindows#

        isWindows: boolean = process.platform === "win32"

        -

        Defined in src/common/vars.ts:7

        +

        Defined in src/common/vars.ts:7


        Const issuesTrackerUrl#

        issuesTrackerUrl: "https://github.com/lensapp/lens/issues" = "https://github.com/lensapp/lens/issues"

        -

        Defined in src/common/vars.ts:43

        +

        Defined in src/common/vars.ts:43


        Const slackUrl#

        slackUrl: "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI" = "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI"

        -

        Defined in src/common/vars.ts:44

        +

        Defined in src/common/vars.ts:44


        Const version#

        version: string = getAppVersion()

        -

        Defined in src/extensions/core-api/app.ts:4

        +

        Defined in src/extensions/core-api/app.ts:4

        Functions#

        getEnabledExtensions#

        getEnabledExtensions(): string[]

        -

        Defined in src/extensions/core-api/app.ts:7

        +

        Defined in src/extensions/core-api/app.ts:7

        Returns: string[]

        diff --git a/latest/extensions/api/modules/_core_api_cluster_feature_/index.html b/latest/extensions/api/modules/_core_api_cluster_feature_/index.html index 1794aedb14..283d2d8e49 100644 --- a/latest/extensions/api/modules/_core_api_cluster_feature_/index.html +++ b/latest/extensions/api/modules/_core_api_cluster_feature_/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • diff --git a/latest/extensions/api/modules/_core_api_event_bus_/index.html b/latest/extensions/api/modules/_core_api_event_bus_/index.html index 370e6ba0e7..4d9696abde 100644 --- a/latest/extensions/api/modules/_core_api_event_bus_/index.html +++ b/latest/extensions/api/modules/_core_api_event_bus_/index.html @@ -598,7 +598,7 @@
      • - Working with mobx + Working with MobX
      • @@ -907,7 +907,7 @@

        Type aliases#

        AppEvent#

        Ƭ AppEvent: object

        -

        Defined in src/common/event-bus.ts:3

        +

        Defined in src/common/event-bus.ts:3

        Type declaration:

        • @@ -923,7 +923,7 @@

          Variables#

          Const appEventBus#

          appEventBus: EventEmitter‹[object]› = new EventEmitter<[AppEvent]>()

          -

          Defined in src/common/event-bus.ts:9

          +

          Defined in src/common/event-bus.ts:9

          diff --git a/latest/extensions/api/modules/_core_api_stores_/index.html b/latest/extensions/api/modules/_core_api_stores_/index.html index dce61c7dcf..a3cd2b9842 100644 --- a/latest/extensions/api/modules/_core_api_stores_/index.html +++ b/latest/extensions/api/modules/_core_api_stores_/index.html @@ -598,7 +598,7 @@
        • - Working with mobx + Working with MobX
        • @@ -950,19 +950,19 @@

          Type aliases#

          ClusterId#

          Ƭ ClusterId: string

          -

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

          +

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


          WorkspaceId#

          Ƭ WorkspaceId: string

          -

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

          +

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

          Variables#

          Const clusterStore#

          clusterStore: ClusterStore‹› = ClusterStore.getInstance()

          -

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

          +

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


          Const workspaceStore#

          workspaceStore: WorkspaceStore‹› = WorkspaceStore.getInstance()

          -

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

          +

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

          diff --git a/latest/extensions/api/modules/_core_api_utils_/index.html b/latest/extensions/api/modules/_core_api_utils_/index.html index b9f079ec2b..1ed716a87b 100644 --- a/latest/extensions/api/modules/_core_api_utils_/index.html +++ b/latest/extensions/api/modules/_core_api_utils_/index.html @@ -598,7 +598,7 @@
        • - Working with mobx + Working with MobX
        • @@ -911,7 +911,7 @@

          Functions#

          cssNames#

          cssNames(...args: IClassName[]): string

          -

          Defined in src/renderer/utils/cssNames.ts:8

          +

          Defined in src/renderer/utils/cssNames.ts:8

          Parameters:

          @@ -931,7 +931,7 @@

          openExternal#

          openExternal(url: string): Promise‹void›

          -

          Defined in src/common/utils/openExternal.ts:4

          +

          Defined in src/common/utils/openExternal.ts:4

          Parameters:

          @@ -951,7 +951,7 @@

          prevDefault#

          prevDefaultE›(callback: function): (Anonymous function)

          -

          Defined in src/renderer/utils/prevDefault.ts:15

          +

          Defined in src/renderer/utils/prevDefault.ts:15

          Type parameters:

          E: SyntheticEvent | Event

          Parameters:

          @@ -976,7 +976,7 @@

          stopPropagation#

          stopPropagation(evt: Event | SyntheticEvent): void

          -

          Defined in src/renderer/utils/prevDefault.ts:24

          +

          Defined in src/renderer/utils/prevDefault.ts:24

          Parameters:

          diff --git a/latest/extensions/api/modules/_interfaces_index_/index.html b/latest/extensions/api/modules/_interfaces_index_/index.html index f80c8a2986..42f5b3fd25 100644 --- a/latest/extensions/api/modules/_interfaces_index_/index.html +++ b/latest/extensions/api/modules/_interfaces_index_/index.html @@ -598,7 +598,7 @@
        • - Working with mobx + Working with MobX
        • @@ -855,15 +855,20 @@
        • AppPreferenceRegistration
        • ClusterFeatureComponents
        • ClusterFeatureRegistration
        • +
        • ClusterPageMenuRegistration
        • KubeObjectDetailComponents
        • KubeObjectDetailRegistration
        • KubeObjectMenuComponents
        • KubeObjectMenuRegistration
        • KubeObjectStatusRegistration
        • +
        • PageComponentProps
        • PageComponents
        • PageMenuComponents
        • PageMenuRegistration
        • +
        • PageParams
        • PageRegistration
        • +
        • PageTarget
        • +
        • RegisteredPage
        • StatusBarRegistration
        • diff --git a/latest/extensions/api/modules/_renderer_api_components_/index.html b/latest/extensions/api/modules/_renderer_api_components_/index.html index cb679667aa..4d9ec94635 100644 --- a/latest/extensions/api/modules/_renderer_api_components_/index.html +++ b/latest/extensions/api/modules/_renderer_api_components_/index.html @@ -598,7 +598,7 @@
        • - Working with mobx + Working with MobX
        • @@ -992,6 +992,27 @@ Const TabLayout + + +
        • + + Const kubeDetailsUrlParam + + +
        • + +
        • + + Const kubeSelectedUrlParam + + +
        • + +
        • + + Const logTabStore + +
        • @@ -999,6 +1020,20 @@ Const notificationsStore +
        • + +
        • + + Const orderByUrlParam + + +
        • + +
        • + + Const sortByUrlParam + +
        • @@ -1036,15 +1071,29 @@
        • - - createPodLogsTab + + createTerminalTab
        • - - createTerminalTab + + getDetailsUrl + + +
        • + +
        • + + hideDetails + + +
        • + +
        • + + showDetails
        • @@ -1087,6 +1136,7 @@
        • Badge
        • Button
        • Checkbox
        • +
        • CommandOverlay
        • ConfirmDialog
        • CubeSpinner
        • Dialog
        • @@ -1105,9 +1155,11 @@
        • Menu
        • MenuActions
        • MenuItem
        • +
        • NamespaceSelect
        • Notifications
        • NotificationsStore
        • PageLayout
        • +
        • PodDetailsList
        • Radio
        • RadioGroup
        • Select
        • @@ -1122,7 +1174,9 @@
        • TableRow
        • Tabs
        • Tooltip
        • +
        • Wizard
        • WizardLayout
        • +
        • WizardStep
        • Interfaces#

          Type aliases#

          Functions#

          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.tsx: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.tsx: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:16


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


          TableSortCallback#

          Ƭ TableSortCallback: function

          -

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

          +

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

          Type declaration:

          ▸ (data: D): string | number | (string | number)[]

          Parameters:

          @@ -1268,7 +1331,7 @@

          TableSortParams#

          Ƭ TableSortParams: object

          -

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

          +

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

          Type declaration:

          @@ -1351,7 +1449,7 @@

          SubMenu(props: Partial‹MenuProps›): Element‹›

          -

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

          +

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

          Parameters:

          @@ -1369,36 +1467,9 @@

          Returns: Element‹›


          -

          createPodLogsTab#

          -

          createPodLogsTab(data: IPodLogsData, tabParams: Partial‹IDockTab›): IDockTab

          -

          Defined in src/renderer/components/dock/pod-logs.store.ts:210

          -

          Parameters:

          - - - - - - - - - - - - - - - - - - - - -
          NameTypeDefault
          dataIPodLogsData-
          tabParamsPartial‹IDockTab›{}
          -

          Returns: IDockTab

          -

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

          Parameters:

          @@ -1418,9 +1489,68 @@

          Returns: IDockTab


          +

          getDetailsUrl#

          +

          getDetailsUrl(details: string, resetSelected: boolean): string

          +

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

          +

          Parameters:

          + + + + + + + + + + + + + + + + + + + + +
          NameTypeDefault
          detailsstring-
          resetSelectedbooleanfalse
          +

          Returns: string

          +
          +

          hideDetails#

          +

          hideDetails(): void

          +

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

          +

          Returns: void

          +
          +

          showDetails#

          +

          showDetails(details: string, resetSelected: boolean): void

          +

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

          +

          Parameters:

          + + + + + + + + + + + + + + + + + + + + +
          NameTypeDefault
          detailsstring""
          resetSelectedbooleantrue
          +

          Returns: void

          +

          withTooltip#

          withTooltipT›(Target: T): T

          -

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

          +

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

          Type parameters:

          T: React.ComponentType‹any›

          Parameters:

          diff --git a/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html b/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html index fa4d89db4d..c4be442594 100644 --- a/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html +++ b/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -598,7 +598,7 @@
        • - Working with mobx + Working with MobX
        • @@ -985,6 +985,13 @@ Const jobApi + + +
        • + + Const limitRangeApi + +
        • @@ -1181,6 +1188,8 @@
        • KubeEvent
        • KubeObject
        • KubeObjectStore
        • +
        • LimitRange
        • +
        • LimitRangesStore
        • Namespace
        • NamespaceStore
        • NetworkPolicy
        • @@ -1243,6 +1252,7 @@
        • hpaApi
        • ingressApi
        • jobApi
        • +
        • limitRangeApi
        • namespacesApi
        • networkPolicyApi
        • nodesApi
        • @@ -1268,7 +1278,7 @@

          Type aliases#

          KubeObjectStatus#

          Ƭ KubeObjectStatus: object

          -

          Defined in src/extensions/renderer-api/kube-object-status.ts:1

          +

          Defined in src/extensions/renderer-api/kube-object-status.ts:1

          Type declaration:

          • @@ -1284,68 +1294,68 @@

            Variables#

            Const apiManager#

            apiManager: ApiManager‹› = new ApiManager()

            -

            Defined in src/renderer/api/api-manager.ts:58

            +

            Defined in src/renderer/api/api-manager.ts:64


            Const clusterRoleApi#

            clusterRoleApi: KubeApiClusterRole‹›› = new KubeApi({ objectConstructor: ClusterRole, })

            -

            Defined in src/renderer/api/endpoints/cluster-role.api.ts:12

            +

            Defined in src/renderer/api/endpoints/cluster-role.api.ts:12


            Const clusterRoleBindingApi#

            clusterRoleBindingApi: KubeApiClusterRoleBinding‹›› = new KubeApi({ objectConstructor: ClusterRoleBinding, })

            -

            Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10

            +

            Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10


            Const configMapApi#

            configMapApi: KubeApiConfigMap‹›› = new KubeApi({ objectConstructor: ConfigMap, })

            -

            Defined in src/renderer/api/endpoints/configmap.api.ts:26

            +

            Defined in src/renderer/api/endpoints/configmap.api.ts:26


            Const crdApi#

            crdApi: KubeApiCustomResourceDefinition‹›› = new KubeApi({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, })

            -

            Defined in src/renderer/api/endpoints/crd.api.ts:154

            +

            Defined in src/renderer/api/endpoints/crd.api.ts:154


            Const cronJobApi#

            -

            cronJobApi: KubeApiCronJob‹›› = new KubeApi({ +

            cronJobApi: CronJobApi‹› = new CronJobApi({ objectConstructor: CronJob, })

            -

            Defined in src/renderer/api/endpoints/cron-job.api.ts:95

            +

            Defined in src/renderer/api/endpoints/cron-job.api.ts:131


            Const daemonSetApi#

            daemonSetApi: KubeApiDaemonSet‹›› = new KubeApi({ objectConstructor: DaemonSet, })

            -

            Defined in src/renderer/api/endpoints/daemon-set.api.ts:74

            +

            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

            +

            Defined in src/renderer/api/endpoints/deployment.api.ts:192


            Const endpointApi#

            endpointApi: KubeApiEndpoint‹›› = new KubeApi({ objectConstructor: Endpoint, })

            -

            Defined in src/renderer/api/endpoints/endpoint.api.ts:127

            +

            Defined in src/renderer/api/endpoints/endpoint.api.ts:127


            Const eventApi#

            eventApi: KubeApiKubeEvent‹›› = new KubeApi({ objectConstructor: KubeEvent, })

            -

            Defined in src/renderer/api/endpoints/events.api.ts:59

            +

            Defined in src/renderer/api/endpoints/events.api.ts:59


            Const hpaApi#

            hpaApi: KubeApiHorizontalPodAutoscaler‹›› = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, })

            -

            Defined in src/renderer/api/endpoints/hpa.api.ts:143

            +

            Defined in src/renderer/api/endpoints/hpa.api.ts:143


            Const ingressApi#

            ingressApi: IngressApi‹› = new IngressApi({ @@ -1355,113 +1365,119 @@ fallbackApiBases: ["/apis/extensions/v1beta1/ingresses"], logStuff: true } as any)

            -

            Defined in src/renderer/api/endpoints/ingress.api.ts:177

            +

            Defined in src/renderer/api/endpoints/ingress.api.ts:177


            Const jobApi#

            jobApi: KubeApiJob‹›› = new KubeApi({ objectConstructor: Job, })

            -

            Defined in src/renderer/api/endpoints/job.api.ts:110

            +

            Defined in src/renderer/api/endpoints/job.api.ts:110

            +
            +

            Const limitRangeApi#

            +

            limitRangeApi: KubeApiLimitRange‹›› = new KubeApi({ + objectConstructor: LimitRange, +})

            +

            Defined in src/renderer/api/endpoints/limit-range.api.ts:55


            Const namespacesApi#

            namespacesApi: KubeApiNamespace‹›› = new KubeApi({ objectConstructor: Namespace, })

            -

            Defined in src/renderer/api/endpoints/namespaces.api.ts:25

            +

            Defined in src/renderer/api/endpoints/namespaces.api.ts:25


            Const networkPolicyApi#

            networkPolicyApi: KubeApiNetworkPolicy‹›› = new KubeApi({ objectConstructor: NetworkPolicy, })

            -

            Defined in src/renderer/api/endpoints/network-policy.api.ts:71

            +

            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

            +

            Defined in src/renderer/api/endpoints/nodes.api.ts:169


            Const pdbApi#

            pdbApi: KubeApiPodDisruptionBudget‹›› = new KubeApi({ objectConstructor: PodDisruptionBudget, })

            -

            Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47

            +

            Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47


            Const persistentVolumeApi#

            persistentVolumeApi: KubeApiPersistentVolume‹›› = new KubeApi({ objectConstructor: PersistentVolume, })

            -

            Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73

            +

            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

            +

            Defined in src/renderer/api/endpoints/pods.api.ts:490


            Const pvcApi#

            pvcApi: PersistentVolumeClaimsApi‹› = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, })

            -

            Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90

            +

            Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90


            Const replicaSetApi#

            -

            replicaSetApi: KubeApiReplicaSet‹›› = new KubeApi({ +

            replicaSetApi: ReplicaSetApi‹› = new ReplicaSetApi({ objectConstructor: ReplicaSet, })

            -

            Defined in src/renderer/api/endpoints/replica-set.api.ts:56

            +

            Defined in src/renderer/api/endpoints/replica-set.api.ts:83


            Const resourceQuotaApi#

            resourceQuotaApi: KubeApiResourceQuota‹›› = new KubeApi({ objectConstructor: ResourceQuota, })

            -

            Defined in src/renderer/api/endpoints/resource-quota.api.ts:66

            +

            Defined in src/renderer/api/endpoints/resource-quota.api.ts:66


            Const roleApi#

            roleApi: KubeApiRole‹›› = new KubeApi({ objectConstructor: Role, })

            -

            Defined in src/renderer/api/endpoints/role.api.ts:21

            +

            Defined in src/renderer/api/endpoints/role.api.ts:21


            Const roleBindingApi#

            roleBindingApi: KubeApiRoleBinding‹›› = new KubeApi({ objectConstructor: RoleBinding, })

            -

            Defined in src/renderer/api/endpoints/role-binding.api.ts:34

            +

            Defined in src/renderer/api/endpoints/role-binding.api.ts:34


            Const secretsApi#

            secretsApi: KubeApiSecret‹›› = new KubeApi({ objectConstructor: Secret, })

            -

            Defined in src/renderer/api/endpoints/secret.api.ts:48

            +

            Defined in src/renderer/api/endpoints/secret.api.ts:48


            Const serviceAccountsApi#

            serviceAccountsApi: KubeApiServiceAccount‹›› = new KubeApi({ objectConstructor: ServiceAccount, })

            -

            Defined in src/renderer/api/endpoints/service-accounts.api.ts:27

            +

            Defined in src/renderer/api/endpoints/service-accounts.api.ts:27


            Const serviceApi#

            serviceApi: KubeApiService‹›› = new KubeApi({ objectConstructor: Service, })

            -

            Defined in src/renderer/api/endpoints/service.api.ts:101

            +

            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

            +

            Defined in src/renderer/api/endpoints/stateful-set.api.ts:110


            Const storageClassApi#

            storageClassApi: KubeApiStorageClass‹›› = new KubeApi({ objectConstructor: StorageClass, })

            -

            Defined in src/renderer/api/endpoints/storage-class.api.ts:37

            +

            Defined in src/renderer/api/endpoints/storage-class.api.ts:37

            Functions#

            forCluster#

            forClusterT›(cluster: IKubeApiCluster, kubeClass: IKubeObjectConstructor‹T›): KubeApi‹T›

            -

            Defined in src/renderer/api/kube-api.ts:66

            +

            Defined in src/renderer/api/kube-api.ts:68

            Type parameters:

            T: KubeObject

            Parameters:

            @@ -1487,7 +1503,7 @@

            isAllowedResource#

            isAllowedResource(resources: KubeResource | KubeResource[]): boolean

            -

            Defined in src/common/rbac.ts:41

            +

            Defined in src/common/rbac.ts:44

            Parameters:

            diff --git a/latest/extensions/api/modules/_renderer_api_navigation_/index.html b/latest/extensions/api/modules/_renderer_api_navigation_/index.html index 46dce73245..dba3f8af76 100644 --- a/latest/extensions/api/modules/_renderer_api_navigation_/index.html +++ b/latest/extensions/api/modules/_renderer_api_navigation_/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • @@ -821,6 +821,13 @@
            @@ -922,8 +952,35 @@ + + + + +
            initPageParamInit‹V›
            +

            Returns: PageParam‹V›

            +
            +

            getDetailsUrl#

            +

            getDetailsUrl(details: string, resetSelected: boolean): string

            +

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

            +

            Parameters:

            + + + + + + + + + + + + + + + +
            NameTypeDefault
            details string-
            resetSelectedbooleanfalse
            @@ -931,14 +988,32 @@

            hideDetails#

            hideDetails(): void

            -

            Defined in src/renderer/navigation.ts:93

            -

            Hide details. Works only in renderer.

            +

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

            Returns: void


            +

            isActiveRoute#

            +

            isActiveRoute(route: string | string[] | RouteProps): boolean

            +

            Defined in src/renderer/navigation/helpers.ts:25

            +

            Parameters:

            + + + + + + + + + + + + + +
            NameType
            routestring | string[] | RouteProps
            +

            Returns: boolean

            +

            navigate(location: LocationDescriptor): void

            -

            Defined in src/renderer/navigation.ts:17

            -

            Navigate to a location. Works only in renderer.

            +

            Defined in src/renderer/navigation/helpers.ts:7

            Parameters:

            @@ -957,9 +1032,8 @@

            Returns: void


            showDetails#

            -

            showDetails(path: string, resetSelected: boolean): void

            -

            Defined in src/renderer/navigation.ts:83

            -

            Show details. Works only in renderer.

            +

            showDetails(details: string, resetSelected: boolean): void

            +

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

            Parameters:

            @@ -971,9 +1045,9 @@ - + - + diff --git a/latest/extensions/api/modules/_renderer_api_theming_/index.html b/latest/extensions/api/modules/_renderer_api_theming_/index.html index c52634a0b8..4713ce1e6c 100644 --- a/latest/extensions/api/modules/_renderer_api_theming_/index.html +++ b/latest/extensions/api/modules/_renderer_api_theming_/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • @@ -876,7 +876,7 @@

            Functions#

            getActiveTheme#

            getActiveTheme(): Theme

            -

            Defined in src/extensions/renderer-api/theming.ts:3

            +

            Defined in src/extensions/renderer-api/theming.ts:3

            Returns: Theme

            diff --git a/latest/extensions/capabilities/color-reference/index.html b/latest/extensions/capabilities/color-reference/index.html index fae59b8c0c..b38c64ec52 100644 --- a/latest/extensions/capabilities/color-reference/index.html +++ b/latest/extensions/capabilities/color-reference/index.html @@ -724,7 +724,7 @@
          • - Working with mobx + Working with MobX
          • @@ -1094,6 +1094,7 @@
            • --buttonPrimaryBackground: button background color for primary actions.
            • --buttonDefaultBackground: default button background color.
            • +
            • --buttonLightBackground: light button background color.
            • --buttonAccentBackground: accent button background color.
            • --buttonDisabledBackground: disabled button background color.
            diff --git a/latest/extensions/capabilities/common-capabilities/index.html b/latest/extensions/capabilities/common-capabilities/index.html index 5a370ea4f4..2424255e01 100644 --- a/latest/extensions/capabilities/common-capabilities/index.html +++ b/latest/extensions/capabilities/common-capabilities/index.html @@ -743,7 +743,7 @@
          • - Working with mobx + Working with MobX
          • @@ -1252,11 +1252,13 @@ exportdefaultclassExampleExtensionextendsLensRendererExtension{statusBarItems=[{ - item:( - <divclassName="flex align-center gaps hover-highlight"onClick={()=>this.navigate("/example-page")}> - <Component.Iconmaterial="favorite"/> - </div> - ) + components:{ + Item:( + <divclassName="flex align-center gaps hover-highlight"onClick={()=>this.navigate("/example-page")}> + <Component.Iconmaterial="favorite"/> + </div> + ) + }}]} diff --git a/latest/extensions/capabilities/index.html b/latest/extensions/capabilities/index.html index 82e819ca43..c455a064d9 100644 --- a/latest/extensions/capabilities/index.html +++ b/latest/extensions/capabilities/index.html @@ -593,7 +593,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/capabilities/styling/index.html b/latest/extensions/capabilities/styling/index.html index 4d19b5aea4..b26bf89206 100644 --- a/latest/extensions/capabilities/styling/index.html +++ b/latest/extensions/capabilities/styling/index.html @@ -701,7 +701,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/get-started/anatomy/index.html b/latest/extensions/get-started/anatomy/index.html index ad3c40cdda..8b3092ef9a 100644 --- a/latest/extensions/get-started/anatomy/index.html +++ b/latest/extensions/get-started/anatomy/index.html @@ -660,7 +660,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/get-started/overview/index.html b/latest/extensions/get-started/overview/index.html index 2e466f45ee..130f8a6e69 100644 --- a/latest/extensions/get-started/overview/index.html +++ b/latest/extensions/get-started/overview/index.html @@ -647,7 +647,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/get-started/wrapping-up/index.html b/latest/extensions/get-started/wrapping-up/index.html index ec4eb5e3d4..6d0e5854de 100644 --- a/latest/extensions/get-started/wrapping-up/index.html +++ b/latest/extensions/get-started/wrapping-up/index.html @@ -654,7 +654,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/get-started/your-first-extension/index.html b/latest/extensions/get-started/your-first-extension/index.html index 5c7ee69211..99e9c500fb 100644 --- a/latest/extensions/get-started/your-first-extension/index.html +++ b/latest/extensions/get-started/your-first-extension/index.html @@ -688,7 +688,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/guides/anatomy/index.html b/latest/extensions/guides/anatomy/index.html index 1c0aa7320e..069db71999 100644 --- a/latest/extensions/guides/anatomy/index.html +++ b/latest/extensions/guides/anatomy/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/guides/components/index.html b/latest/extensions/guides/components/index.html index b32d1c7e23..3be6694415 100644 --- a/latest/extensions/guides/components/index.html +++ b/latest/extensions/guides/components/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/guides/generator/index.html b/latest/extensions/guides/generator/index.html index b25f99a24d..aae1b832f1 100644 --- a/latest/extensions/guides/generator/index.html +++ b/latest/extensions/guides/generator/index.html @@ -661,7 +661,7 @@
          • - Working with mobx + Working with MobX
          • @@ -944,15 +944,15 @@ npm start # start the webpack server in watch mode

            Developing the Extension#

            Next, you'll try changing the way the new menu item appears in the UI. You'll change it from "Hello World" to "Hello Lens".

            Open my-first-lens-ext/renderer.tsx and change the value of title from "Hello World" to "Hello Lens":

            -
            clusterPageMenus = [
            -    {
            -        target: { pageId: "hello" },
            -        title: "Hello Lens",
            -        components: {
            -            Icon: ExampleIcon,
            -        }
            -    }
            -]
            +
            clusterPageMenus = [
            +    {
            +        target: { pageId: "hello" },
            +        title: "Hello Lens",
            +        components: {
            +            Icon: ExampleIcon,
            +        }
            +    }
            +]
             

            Reload Lens and you will see that the menu item text has changed to "Hello Lens." To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.

            Hello World

            diff --git a/latest/extensions/guides/images/clusterpagemenus.png b/latest/extensions/guides/images/clusterpagemenus.png new file mode 100644 index 0000000000..3ed1c79e5b Binary files /dev/null and b/latest/extensions/guides/images/clusterpagemenus.png differ diff --git a/latest/extensions/guides/images/globalpagemenus.png b/latest/extensions/guides/images/globalpagemenus.png new file mode 100644 index 0000000000..e986cc32e9 Binary files /dev/null and b/latest/extensions/guides/images/globalpagemenus.png differ diff --git a/latest/extensions/guides/index.html b/latest/extensions/guides/index.html index 5035536fd3..854dbbbba1 100644 --- a/latest/extensions/guides/index.html +++ b/latest/extensions/guides/index.html @@ -647,7 +647,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/guides/kube-object-list-layout/index.html b/latest/extensions/guides/kube-object-list-layout/index.html index 1543a96772..f522b861cd 100644 --- a/latest/extensions/guides/kube-object-list-layout/index.html +++ b/latest/extensions/guides/kube-object-list-layout/index.html @@ -598,7 +598,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/guides/main-extension/index.html b/latest/extensions/guides/main-extension/index.html index 3471cae1ef..36b5c5b30b 100644 --- a/latest/extensions/guides/main-extension/index.html +++ b/latest/extensions/guides/main-extension/index.html @@ -660,7 +660,7 @@
          • - Working with mobx + Working with MobX
          • diff --git a/latest/extensions/guides/renderer-extension/index.html b/latest/extensions/guides/renderer-extension/index.html index 2932ba54e7..c61bb64200 100644 --- a/latest/extensions/guides/renderer-extension/index.html +++ b/latest/extensions/guides/renderer-extension/index.html @@ -615,6 +615,13 @@
            ); }) 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:210 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:58 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:41 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:58","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:41 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 # This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension. Guides # Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx 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":"This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension.","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":"Lens Extension Generator # The Lens Extension Generator creates a directory with the necessary files for developing an extension. Installing and Getting Started with the Generator # To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? 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 :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources : Developing the Extension # Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens.\" To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux. Debugging the Extension # To debug your extension, please see our instructions on Testing Extensions . Next Steps # To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the Lens contribution guidelines here . The Generator source code is hosted at Github .","title":"Generator"},{"location":"extensions/guides/generator/#lens-extension-generator","text":"The Lens Extension Generator creates a directory with the necessary files for developing an extension.","title":"Lens Extension Generator"},{"location":"extensions/guides/generator/#installing-and-getting-started-with-the-generator","text":"To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? 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 :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources :","title":"Installing and Getting Started with the Generator"},{"location":"extensions/guides/generator/#developing-the-extension","text":"Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens.\" To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"To debug your extension, please see our instructions on Testing Extensions .","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#next-steps","text":"To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the Lens contribution guidelines here . The Generator source code 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's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process. LensMainExtension Class # onActivate() and onDeactivate() Methods # 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' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active 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\" ); } } For more details on accessing Lens state data, please see the Stores guide. appMenus # The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an 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 that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows: parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\" , \"edit\" , \"view\" , and \"help\" . \"lens\" is valid on Mac only. label is the name of your menu item. click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending it.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#main-extension","text":"The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#lensmainextension-class","text":"","title":"LensMainExtension Class"},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","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' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active 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\" ); } } For more details on accessing Lens state data, please see the Stores guide.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/main-extension/#appmenus","text":"The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an 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 that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows: parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\" , \"edit\" , \"view\" , and \"help\" . \"lens\" is valid on Mac only. label is the name of your menu item. click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending 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 Why Lens window rendering is broken? # MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display . Same thing can happen with any of Electron applications or Chrome itself. As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app. First, open .bash_profile file from your terminal open -a TextEdit.app ~/.bash_profile Then, add this line export LENS_DISABLE_GPU=true","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":"faq/#why-lens-window-rendering-is-broken","text":"MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display . Same thing can happen with any of Electron applications or Chrome itself. As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app. First, open .bash_profile file from your terminal open -a TextEdit.app ~/.bash_profile Then, add this line export LENS_DISABLE_GPU=true","title":"Why Lens window rendering is broken?"},{"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 Developing on Windows # On Windows we only support Git Bash (or similar shell) for running commands. Github Workflow # We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow Code Testing # All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing License # By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"Development"},{"location":"contributing/development/#development","text":"Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.","title":"Development"},{"location":"contributing/development/#recommended-reading","text":"TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs)","title":"Recommended Reading:"},{"location":"contributing/development/#local-development-environment","text":"Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts","title":"Local Development Environment"},{"location":"contributing/development/#developing-on-windows","text":"On Windows we only support Git Bash (or similar shell) for running commands.","title":"Developing on Windows"},{"location":"contributing/development/#github-workflow","text":"We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow","title":"Github Workflow"},{"location":"contributing/development/#code-testing","text":"All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing","title":"Code Testing"},{"location":"contributing/development/#license","text":"By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"License"},{"location":"contributing/documentation/","text":"Documentation # We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source . Finding Documentation Issues to Work On # You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request. Requirements for Documentation Pull Requests # When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. Testing Documentation Site Locally # Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Documentation"},{"location":"contributing/documentation/#documentation","text":"We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source .","title":"Documentation"},{"location":"contributing/documentation/#finding-documentation-issues-to-work-on","text":"You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request.","title":"Finding Documentation Issues to Work On"},{"location":"contributing/documentation/#requirements-for-documentation-pull-requests","text":"When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.","title":"Requirements for Documentation Pull Requests"},{"location":"contributing/documentation/#testing-documentation-site-locally","text":"Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Testing Documentation Site Locally"},{"location":"contributing/github_workflow/","text":"Github Workflow # Fork The Project Adding the Forked Remote Create & Rebase Your Feature Branch Commit & Push Open a Pull Request Get a code review Squash commits Push Your Final Changes This guide assumes you have already cloned the upstream repo to your system via git clone. Fork The Project # Go to http://github.com/lensapp/lens On the top, right-hand side, click on \"fork\" and select your username for the fork destination. Adding the Forked Remote # export GITHUB_USER={ your github's username } cd $WORKDIR/lens git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git # Prevent push to Upstream git remote set-url --push origin no_push # Set your fork remote as a default push target git push --set-upstream $GITHUB_USER master Your remotes should look something like this: \u279c git remote -v origin https://github.com/lensapp/lens (fetch) origin no_push (push) my_fork git@github.com:{ github_username }/lens.git (fetch) my_fork git@github.com:{ github_username }/lens.git (push) Create & Rebase Your Feature Branch # Create a feature branch: git branch -b my_feature_branch Rebase your branch: git fetch origin git rebase origin/master Current branch my_feature_branch is up to date. Please don't use git pull instead of the above fetch / rebase . git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. Commit & Push # Commit and sign your changes: git commit -m \"my commit title\" --signoff You can go back and edit/build/test some more, then commit --amend in a few cycles. When ready, push your changes to your fork's repository: git push --set-upstream my_fork my_feature_branch Open a Pull Request # See Github Docs . Get a code review # Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. Commit changes made in response to review comments should be added to the same branch on your fork. Very small PRs are easy to review. Very large PRs are very difficult to review. Squashing Commits # Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. To do that, it's best to perform an interactive rebase : Example If you PR has 3 commits, count backwards from your last commit using HEAD~3 : git rebase -i HEAD~3 Output would be similar to this: pick f7f3f6d Changed some code pick 310154e fixed some typos pick a5f4a0d made some review changes # Rebase 710f0f8..a5f4a0d onto 710f0f8 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like \"squash\", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # b, break = stop here (continue rebase later with 'git rebase --continue') # d, drop = remove commit # l, label
            pathdetails string-""
            resetSelected
            + + + + + + + + + + + + + + + + + + + +
            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.1.0/extensions/api/classes/_core_api_stores_.cluster/index.html b/v4.1.0/extensions/api/classes/_core_api_stores_.cluster/index.html new file mode 100644 index 0000000000..d75a8e26dc --- /dev/null +++ b/v4.1.0/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -0,0 +1,2184 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Cluster - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelClusterModel
    +

    Returns: Cluster

    +

    Properties#

    +

    accessible#

    +

    accessible: boolean = false

    +

    Defined in src/main/cluster.ts:149

    +

    Can user access cluster resources

    +

    observable

    +
    +

    accessibleNamespaces#

    +

    accessibleNamespaces: string[] = []

    +

    Implementation of ClusterModel.accessibleNamespaces

    +

    Defined in src/main/cluster.ts:216

    +

    List of accessible namespaces provided by user in the Cluster Settings

    +

    observable

    +
    +

    Protected activated#

    +

    activated: boolean = false

    +

    Defined in src/main/cluster.ts:82

    +
    +

    allowedNamespaces#

    +

    allowedNamespaces: string[] = []

    +

    Defined in src/main/cluster.ts:203

    +

    List of allowed namespaces verified via K8S::SelfSubjectAccessReview api

    +

    observable

    +
    +

    allowedResources#

    +

    allowedResources: string[] = []

    +

    Defined in src/main/cluster.ts:210

    +

    List of allowed resources

    +

    observable

    +

    internal

    +
    +

    apiUrl#

    +

    apiUrl: string

    +

    Defined in src/main/cluster.ts:124

    +

    Kubernetes API server URL

    +

    observable

    +
    +

    contextHandler#

    +

    contextHandler: ContextHandler

    +

    Defined in src/main/cluster.ts:73

    +

    Context handler

    +

    internal

    +
    +

    contextName#

    +

    contextName: string

    +

    Implementation of ClusterModel.contextName

    +

    Defined in src/main/cluster.ts:106

    +

    Kubeconfig context name

    +

    observable

    +
    +

    disconnected#

    +

    disconnected: boolean = true

    +

    Defined in src/main/cluster.ts:167

    +

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

    +

    observable

    +
    +

    enabled#

    +

    enabled: boolean = false

    +

    Defined in src/main/cluster.ts:137

    +

    Is cluster instance enabled (disabled clusters are currently hidden)

    +

    observable

    +
    +

    Protected eventDisposers#

    +

    eventDisposers: Function[] = []

    +

    Defined in src/main/cluster.ts:81

    +
    +

    failureReason#

    +

    failureReason: string

    +

    Defined in src/main/cluster.ts:173

    +

    Connection failure reason

    +

    observable

    +
    +

    id#

    +

    id: ClusterId

    +

    Implementation of ClusterModel.id

    +

    Defined in src/main/cluster.ts:61

    +

    Unique id for a cluster

    +
    +

    initialized#

    +

    initialized: boolean = false

    +

    Defined in src/main/cluster.ts:100

    +

    Is cluster object initialized

    +

    observable

    +
    +

    initializing#

    +

    initializing: boolean = false

    +

    Defined in src/main/cluster.ts:93

    +

    Is cluster object initializinng on-going

    +

    observable

    +
    +

    isAdmin#

    +

    isAdmin: boolean = false

    +

    Defined in src/main/cluster.ts:179

    +

    Does user have admin like access

    +

    observable

    +
    +

    isGlobalWatchEnabled#

    +

    isGlobalWatchEnabled: boolean = false

    +

    Defined in src/main/cluster.ts:185

    +

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

    +

    observable

    +
    +

    kubeConfigPath#

    +

    kubeConfigPath: string

    +

    Implementation of ClusterModel.kubeConfigPath

    +

    Defined in src/main/cluster.ts:118

    +

    Path to kubeconfig

    +

    observable

    +
    +

    kubeCtl#

    +

    kubeCtl: Kubectl

    +

    Defined in src/main/cluster.ts:67

    +

    Kubectl

    +

    internal

    +
    +

    kubeProxyUrl#

    +

    kubeProxyUrl: string

    +

    Defined in src/main/cluster.ts:131

    +

    Internal authentication proxy URL

    +

    observable

    +

    internal

    +
    +

    Protected kubeconfigManager#

    +

    kubeconfigManager: KubeconfigManager

    +

    Defined in src/main/cluster.ts:80

    +
    +

    metadata#

    +

    metadata: ClusterMetadata

    +

    Implementation of ClusterModel.metadata

    +

    Defined in src/main/cluster.ts:197

    +

    Metadata

    +

    observable

    +
    +

    online#

    +

    online: boolean = false

    +

    Defined in src/main/cluster.ts:143

    +

    Is cluster online

    +

    observable

    +
    +

    ownerRef#

    +

    ownerRef: string

    +

    Implementation of ClusterModel.ownerRef

    +

    Defined in src/main/cluster.ts:79

    +

    Owner reference

    +

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

    +
    +

    preferences#

    +

    preferences: ClusterPreferences

    +

    Implementation of ClusterModel.preferences

    +

    Defined in src/main/cluster.ts:191

    +

    Preferences

    +

    observable

    +
    +

    ready#

    +

    ready: boolean = false

    +

    Defined in src/main/cluster.ts:155

    +

    Is cluster instance in usable state

    +

    observable

    +
    +

    reconnecting#

    +

    reconnecting: boolean = false

    +

    Defined in src/main/cluster.ts:161

    +

    Is cluster currently reconnecting

    +

    observable

    +
    +

    whenInitialized#

    +

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

    +

    Defined in src/main/cluster.ts:85

    +
    +

    whenReady#

    +

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

    +

    Defined in src/main/cluster.ts:86

    +
    +

    workspace#

    +

    workspace: WorkspaceId

    +

    Implementation of ClusterModel.workspace

    +

    Defined in src/main/cluster.ts:112

    +

    Workspace id

    +

    observable

    +

    Accessors#

    +

    available#

    +

    get available(): boolean

    +

    Defined in src/main/cluster.ts:223

    +

    Is cluster available

    +

    computed

    +

    Returns: boolean

    +
    +

    isManaged#

    +

    get isManaged(): boolean

    +

    Defined in src/main/cluster.ts:269

    +

    Is cluster managed by an extension

    +

    Returns: boolean

    +
    +

    name#

    +

    get name(): string

    +

    Defined in src/main/cluster.ts:232

    +

    Cluster name

    +

    computed

    +

    Returns: string

    +
    +

    prometheusPreferences#

    +

    get prometheusPreferences(): ClusterPrometheusPreferences

    +

    Defined in src/main/cluster.ts:242

    +

    Prometheus preferences

    +

    computed

    +

    internal

    +

    Returns: ClusterPrometheusPreferences

    +
    +

    version#

    +

    get version(): string

    +

    Defined in src/main/cluster.ts:253

    +

    Kubernetes version

    +

    Returns: string

    +

    Methods#

    +

    activate#

    +

    activate(force: boolean): Promise‹void›

    +

    Defined in src/main/cluster.ts:345

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    forcebooleanfalseforce activation
    +

    Returns: Promise‹void›

    +
    +

    Protected bindEvents#

    +

    bindEvents(): void

    +

    Defined in src/main/cluster.ts:314

    +

    internal

    +

    Returns: void

    +
    +

    canI#

    +

    canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:560

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    resourceAttributesV1ResourceAttributesresource attributes
    +

    Returns: Promise‹boolean›

    +
    +

    canUseWatchApi#

    +

    canUseWatchApi(customizeResource: V1ResourceAttributes): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:592

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    customizeResourceV1ResourceAttributes{}
    +

    Returns: Promise‹boolean›

    +
    +

    disconnect#

    +

    disconnect(): void

    +

    Defined in src/main/cluster.ts:393

    +

    internal

    +

    Returns: void

    +
    +

    Protected ensureKubectl#

    +

    ensureKubectl(): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:373

    +

    internal

    +

    Returns: Promise‹boolean›

    +
    +

    Protected getAllowedNamespaces#

    +

    getAllowedNamespaces(): Promise‹string[]›

    +

    Defined in src/main/cluster.ts:671

    +

    Returns: Promise‹string[]›

    +
    +

    Protected getAllowedResources#

    +

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

    +

    Defined in src/main/cluster.ts:691

    +

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

    +
    +

    Protected getConnectionStatus#

    +

    getConnectionStatus(): Promise‹ClusterStatus›

    +

    Defined in src/main/cluster.ts:516

    +

    Returns: Promise‹ClusterStatus›

    +
    +

    Protected getKubeconfig#

    +

    getKubeconfig(): KubeConfig

    +

    Defined in src/main/cluster.ts:471

    +

    Returns: KubeConfig

    +
    +

    getMeta#

    +

    getMeta(): object

    +

    Defined in src/main/cluster.ts:659

    +

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

    +

    internal

    +

    Parameters:

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

    Returns: Promise‹any›

    +
    +

    getProxyKubeconfig#

    +

    getProxyKubeconfig(): KubeConfig

    +

    Defined in src/main/cluster.ts:478

    +

    internal

    +

    Returns: KubeConfig

    +
    +

    getProxyKubeconfigPath#

    +

    getProxyKubeconfigPath(): string

    +

    Defined in src/main/cluster.ts:485

    +

    internal

    +

    Returns: string

    +
    +

    getState#

    +

    getState(): ClusterState

    +

    Defined in src/main/cluster.ts:620

    +

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

    +

    Returns: ClusterState

    +
    +

    init#

    +

    init(port: number): Promise‹void›

    +

    Defined in src/main/cluster.ts:289

    +

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

    +

    internal

    +

    Parameters:

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

    Returns: Promise‹void›

    +
    +

    isAllowedResource#

    +

    isAllowedResource(kind: string): boolean

    +

    Defined in src/main/cluster.ts:726

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    kindstring
    +

    Returns: boolean

    +
    +

    isClusterAdmin#

    +

    isClusterAdmin(): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:581

    +

    internal

    +

    Returns: Promise‹boolean›

    +
    +

    Protected k8sRequest#

    +

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

    +

    Defined in src/main/cluster.ts:489

    +

    Type parameters:

    +

    T

    +

    Parameters:

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

    Returns: Promise‹T›

    +
    +

    pushState#

    +

    pushState(state: ClusterState): void

    +

    Defined in src/main/cluster.ts:653

    +

    internal

    +

    Parameters:

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

    Returns: void

    +
    +

    reconnect#

    +

    reconnect(): Promise‹void›

    +

    Defined in src/main/cluster.ts:383

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refresh#

    +

    refresh(opts: ClusterRefreshOptions): Promise‹void›

    +

    Defined in src/main/cluster.ts:412

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    optsClusterRefreshOptions{}refresh options
    +

    Returns: Promise‹void›

    +
    +

    refreshAllowedResources#

    +

    refreshAllowedResources(): Promise‹void›

    +

    Defined in src/main/cluster.ts:466

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refreshConnectionStatus#

    +

    refreshConnectionStatus(): Promise‹void›

    +

    Defined in src/main/cluster.ts:455

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refreshMetadata#

    +

    refreshMetadata(): Promise‹void›

    +

    Defined in src/main/cluster.ts:431

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    setState#

    +

    setState(state: ClusterState): void

    +

    Defined in src/main/cluster.ts:645

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    stateClusterStatecluster state
    +

    Returns: void

    +
    +

    toJSON#

    +

    toJSON(): ClusterModel

    +

    Defined in src/main/cluster.ts:600

    +

    Returns: ClusterModel

    +
    +

    Protected unbindEvents#

    +

    unbindEvents(): void

    +

    Defined in src/main/cluster.ts:334

    +

    internal

    +

    Returns: void

    +
    +

    updateModel#

    +

    updateModel(model: ClusterModel): void

    +

    Defined in src/main/cluster.ts:278

    +

    Update cluster data model

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    modelClusterModel
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/v4.1.0/extensions/api/classes/_core_api_stores_.clusterstore/index.html new file mode 100644 index 0000000000..7a89b3d619 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_core_api_stores_.clusterstore/index.html @@ -0,0 +1,1346 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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#

    +

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

    +

    Inherited from ExtensionStore.getInstance

    +

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

    +

    Type parameters:

    +

    T

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsConstructorParameters‹Constructor‹T››
    +

    Returns: T

    +
    +

    Static resetInstance#

    +

    resetInstance(): void

    +

    Inherited from ExtensionStore.resetInstance

    +

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

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/v4.1.0/extensions/api/classes/_core_api_stores_.extensionstore/index.html new file mode 100644 index 0000000000..1aa2a834bc --- /dev/null +++ b/v4.1.0/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ExtensionStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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#

    +

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

    +

    Inherited from ExtensionStore.getInstance

    +

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

    +

    Type parameters:

    +

    T

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsConstructorParameters‹Constructor‹T››
    +

    Returns: T

    +
    +

    Static resetInstance#

    +

    resetInstance(): void

    +

    Inherited from ExtensionStore.resetInstance

    +

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

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_core_api_stores_.workspace/index.html b/v4.1.0/extensions/api/classes/_core_api_stores_.workspace/index.html new file mode 100644 index 0000000000..f7b5eb7823 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_core_api_stores_.workspace/index.html @@ -0,0 +1,1283 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Workspace - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

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

    +

    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

    +
    +

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

    +

    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#

    +

    enabled#

    +

    get enabled(): boolean

    +

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

    +

    Is workspace enabled

    +

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

    +

    observable

    +

    Returns: boolean

    +

    set enabled(enabled: boolean): void

    +

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

    +

    Is workspace enabled

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    enabledboolean
    +

    Returns: void

    +
    +

    isManaged#

    +

    get isManaged(): boolean

    +

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

    +

    Is workspace managed by an extension

    +

    Returns: boolean

    +

    Methods#

    +

    getState#

    +

    getState(): WorkspaceState

    +

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

    +

    Get workspace state

    +

    Returns: WorkspaceState

    +
    +

    pushState#

    +

    pushState(state: WorkspaceState): void

    +

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

    +

    Push state

    +

    interal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    stateWorkspaceStatethis.getState()workspace state
    +

    Returns: void

    +
    +

    setState#

    +

    setState(state: WorkspaceState): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    stateWorkspaceStateworkspace state
    +

    Returns: void

    +
    +

    toJSON#

    +

    toJSON(): WorkspaceModel

    +

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

    +

    Returns: WorkspaceModel

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/v4.1.0/extensions/api/classes/_core_api_stores_.workspacestore/index.html new file mode 100644 index 0000000000..02872319ec --- /dev/null +++ b/v4.1.0/extensions/api/classes/_core_api_stores_.workspacestore/index.html @@ -0,0 +1,1370 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WorkspaceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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#

    +

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

    +

    Inherited from ExtensionStore.getInstance

    +

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

    +

    Type parameters:

    +

    T

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsConstructorParameters‹Constructor‹T››
    +

    Returns: T

    +
    +

    Static resetInstance#

    +

    resetInstance(): void

    +

    Inherited from ExtensionStore.resetInstance

    +

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

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_core_api_utils_.singleton/index.html b/v4.1.0/extensions/api/classes/_core_api_utils_.singleton/index.html new file mode 100644 index 0000000000..63bca6d988 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_core_api_utils_.singleton/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Singleton - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Singleton#

    +

    Hierarchy#

    +
      +
    • Singleton
    • +
    +

    ClusterStore

    +

    WorkspaceStore

    +

    Index#

    +

    Methods#

    + +

    Methods#

    +

    Static getInstance#

    +

    getInstanceT›(...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.1.0/extensions/api/classes/_renderer_api_components_.badge/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.badge/index.html new file mode 100644 index 0000000000..f584d67970 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.badge/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Badge ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Badge ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Badge

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Badge(props: Readonly‹BadgeProps› | BadgeProps): Badge

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹BadgeProps› | BadgeProps
    +

    Returns: Badge

    +

    + new Badge(props: BadgeProps, context: any): Badge

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsBadgeProps
    contextany
    +

    Returns: Badge

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

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

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

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

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

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

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.button/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.button/index.html new file mode 100644 index 0000000000..f4210f693e --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.button/index.html @@ -0,0 +1,1381 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Button ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.checkbox/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.checkbox/index.html new file mode 100644 index 0000000000..e78393579d --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.checkbox/index.html @@ -0,0 +1,1423 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Checkbox ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

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

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html new file mode 100644 index 0000000000..5dbc9be03e --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html @@ -0,0 +1,996 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CommandOverlay - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html new file mode 100644 index 0000000000..07e1e09a1c --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html @@ -0,0 +1,1850 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfirmDialog ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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› | ConfirmDialogProps): ConfirmDialog

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹ConfirmDialogProps› | ConfirmDialogProps
    +

    Returns: ConfirmDialog

    +

    + new ConfirmDialog(props: ConfirmDialogProps, context: any): ConfirmDialog

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsConfirmDialogProps
    contextany
    +

    Returns: ConfirmDialog

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

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

    +
    +

    props#

    +

    props: Readonly‹ConfirmDialogProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

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

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:26

    +
    +

    Static params#

    +

    params: ConfirmDialogParams

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:27

    +

    Accessors#

    +

    params#

    +

    get params(): ConfirmDialogParams

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:47

    +

    Returns: ConfirmDialogParams

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:65

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:51

    +

    Returns: Promise‹void›

    +
    +

    onClose#

    +

    onClose(): void

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:61

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:69

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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:36

    +

    Returns: void

    +
    +

    Static open#

    +

    open(params: ConfirmDialogParams): void

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:31

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsConfirmDialogParams
    +

    Returns: void

    +

    Object literals#

    +

    defaultParams#

    +

    defaultParams: object#

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:40

    +

    icon#

    +

    icon: Element‹› =

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:44

    +

    labelCancel#

    +

    labelCancel: string = "Cancel"

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:43

    +

    labelOk#

    +

    labelOk: string = "Ok"

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:42

    +

    ok#

    +

    ok: any = noop

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:41

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.cubespinner/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.cubespinner/index.html new file mode 100644 index 0000000000..d7d664c54c --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CubeSpinner ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: CubeSpinner ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    CubeSpinner

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CubeSpinner(props: Readonly‹CubeSpinnerProps› | CubeSpinnerProps): CubeSpinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹CubeSpinnerProps› | CubeSpinnerProps
    +

    Returns: CubeSpinner

    +

    + new CubeSpinner(props: CubeSpinnerProps, context: any): CubeSpinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsCubeSpinnerProps
    contextany
    +

    Returns: CubeSpinner

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.dialog/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.dialog/index.html new file mode 100644 index 0000000000..5051c88d16 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -0,0 +1,1739 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Dialog ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:697

    +

    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:726

    +

    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:756

    +

    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:676

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.drawer/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.drawer/index.html new file mode 100644 index 0000000000..da6ae6874a --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -0,0 +1,1748 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Drawer ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Drawer ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Drawer

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Drawer(props: Readonly‹DrawerProps› | DrawerProps): Drawer

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerProps› | DrawerProps
    +

    Returns: Drawer

    +

    + new Drawer(props: DrawerProps, context: any): Drawer

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerProps
    contextany
    +

    Returns: Drawer

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.draweritem/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.draweritem/index.html new file mode 100644 index 0000000000..898bf513f1 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerItem ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: DrawerItem ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    DrawerItem

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerItem(props: Readonly‹DrawerItemProps› | DrawerItemProps): DrawerItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerItemProps› | DrawerItemProps
    +

    Returns: DrawerItem

    +

    + new DrawerItem(props: DrawerItemProps, context: any): DrawerItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerItemProps
    contextany
    +

    Returns: DrawerItem

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html new file mode 100644 index 0000000000..28e63a21b6 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -0,0 +1,1627 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerParamToggler ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: DrawerParamToggler ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    DrawerParamToggler

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerParamToggler(props: Readonly‹DrawerParamTogglerProps› | DrawerParamTogglerProps): DrawerParamToggler

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerParamTogglerProps› | DrawerParamTogglerProps
    +

    Returns: DrawerParamToggler

    +

    + new DrawerParamToggler(props: DrawerParamTogglerProps, context: any): DrawerParamToggler

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerParamTogglerProps
    contextany
    +

    Returns: DrawerParamToggler

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:14

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:20

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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:16

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.drawertitle/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.drawertitle/index.html new file mode 100644 index 0000000000..b64cb5be37 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerTitle ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: DrawerTitle ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    DrawerTitle

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerTitle(props: Readonly‹DrawerTitleProps› | DrawerTitleProps): DrawerTitle

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerTitleProps› | DrawerTitleProps
    +

    Returns: DrawerTitle

    +

    + new DrawerTitle(props: DrawerTitleProps, context: any): DrawerTitle

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerTitleProps
    contextany
    +

    Returns: DrawerTitle

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.icon/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.icon/index.html new file mode 100644 index 0000000000..4ff11ea3fb --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -0,0 +1,1526 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Icon ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:676

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.input/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.input/index.html new file mode 100644 index 0000000000..3f2f1bb4e3 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.input/index.html @@ -0,0 +1,2069 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Input ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Input ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Input

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Input(props: Readonly‹InputProps› | InputProps): Input

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹InputProps› | InputProps
    +

    Returns: Input

    +

    + new Input(props: InputProps, context: any): Input

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsInputProps
    contextany
    +

    Returns: Input

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html new file mode 100644 index 0000000000..d2202ecfb6 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -0,0 +1,1615 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeEventDetails ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeEventDetails ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    KubeEventDetails

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeEventDetails(props: Readonly‹KubeEventDetailsProps› | KubeEventDetailsProps): KubeEventDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeEventDetailsProps› | KubeEventDetailsProps
    +

    Returns: KubeEventDetails

    +

    + new KubeEventDetails(props: KubeEventDetailsProps, context: any): KubeEventDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeEventDetailsProps
    contextany
    +

    Returns: KubeEventDetails

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:16

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:20

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html new file mode 100644 index 0000000000..86feb4d2b4 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -0,0 +1,1739 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectDetails ‹**P, S, SS, P, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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› | P): KubeObjectDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹P› | P
    +

    Returns: KubeObjectDetails

    +

    + new KubeObjectDetails(props: P, context: any): KubeObjectDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsP
    contextany
    +

    Returns: KubeObjectDetails

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:60

    +
    +

    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 = <>Resource loading has failed: <b>{err.toString()}</b>;
    +    } finally {
    +      this.isLoading = false;
    +    }
    +  }
    +}
    +
    +

    })

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:80

    +
    +

    loadingError#

    +

    loadingError: React.ReactNode

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:61

    +
    +

    props#

    +

    props: Readonly‹P› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:75

    +

    Returns: boolean

    +
    +

    object#

    +

    get object(): any

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:67

    +

    Returns: any

    +
    +

    path#

    +

    get path(): string

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:63

    +

    Returns: string

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:105

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html new file mode 100644 index 0000000000..bc6784a5d5 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -0,0 +1,1679 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectListLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeObjectListLayout ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    KubeObjectListLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectListLayout(props: Readonly‹KubeObjectListLayoutProps› | KubeObjectListLayoutProps): KubeObjectListLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectListLayoutProps› | KubeObjectListLayoutProps
    +

    Returns: KubeObjectListLayout

    +

    + new KubeObjectListLayout(props: KubeObjectListLayoutProps, context: any): KubeObjectListLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectListLayoutProps
    contextany
    +

    Returns: KubeObjectListLayout

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:20

    +

    Returns: any

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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/kube-object/kube-object-list-layout.tsx:24

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:36

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeObject
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:44

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html new file mode 100644 index 0000000000..9e5f6d7fdb --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -0,0 +1,1717 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectMenu ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeObjectMenu ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    KubeObjectMenu

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectMenu(props: Readonly‹KubeObjectMenuProps› | KubeObjectMenuProps): KubeObjectMenu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectMenuProps› | KubeObjectMenuProps
    +

    Returns: KubeObjectMenu

    +

    + new KubeObjectMenu(props: KubeObjectMenuProps, context: any): KubeObjectMenu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectMenuProps
    contextany
    +

    Returns: KubeObjectMenu

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:25

    +

    Returns: boolean

    +
    +

    isRemovable#

    +

    get isRemovable(): boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:31

    +

    Returns: boolean

    +
    +

    store#

    +

    get store(): KubeObjectStore‹any›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:17

    +

    Returns: KubeObjectStore‹any›

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:44

    +

    Returns: Promise‹void›

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:63

    +

    Returns: Element‹›

    +
    +

    renderRemoveMessage#

    +

    renderRemoveMessage(): Element‹›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:53

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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:38

    +

    Returns: Promise‹void›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html new file mode 100644 index 0000000000..f25d480cff --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -0,0 +1,1658 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectMeta ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: KubeObjectMeta ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    KubeObjectMeta

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectMeta(props: Readonly‹KubeObjectMetaProps› | KubeObjectMetaProps): KubeObjectMeta

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectMetaProps› | KubeObjectMetaProps
    +

    Returns: KubeObjectMeta

    +

    + new KubeObjectMeta(props: KubeObjectMetaProps, context: any): KubeObjectMeta

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectMetaProps
    contextany
    +

    Returns: KubeObjectMeta

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:15

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    fieldIKubeMetaField
    +

    Returns: boolean

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:25

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.lineprogress/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.lineprogress/index.html new file mode 100644 index 0000000000..f43963c5aa --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -0,0 +1,1464 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LineProgress ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:676

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.menu/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.menu/index.html new file mode 100644 index 0000000000..89749b0898 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -0,0 +1,2011 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Menu ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Menu ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Menu

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Menu(props: Readonly‹MenuProps› | MenuProps): Menu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuProps› | MenuProps
    +

    Returns: Menu

    +

    + new Menu(props: MenuProps, context: any): Menu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuProps
    contextany
    +

    Returns: Menu

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:56

    +
    +

    Protected items#

    +

    items: object

    +

    Defined in src/renderer/components/menu/menu.tsx:57

    +

    Type declaration:

    + +
    +

    opener#

    +

    opener: HTMLElement

    +

    Defined in src/renderer/components/menu/menu.tsx:55

    +
    +

    props#

    +

    props: Readonly‹MenuProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    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:124

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:59

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:53

    +

    Accessors#

    +

    Protected focusableItems#

    +

    get focusableItems(): MenuItem‹›[]

    +

    Defined in src/renderer/components/menu/menu.tsx:98

    +

    Returns: MenuItem‹›[]

    +
    +

    Protected focusedItem#

    +

    get focusedItem(): MenuItem‹›

    +

    Defined in src/renderer/components/menu/menu.tsx:102

    +

    Returns: MenuItem‹›

    +
    +

    isOpen#

    +

    get isOpen(): boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:61

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemMenuItem
    indexnumber
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    bindRef(elem: HTMLUListElement): void

    +

    Defined in src/renderer/components/menu/menu.tsx:235

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLUListElement
    +

    Returns: void

    +
    +

    close#

    +

    close(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:168

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    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:65

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:87

    +

    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:756

    +

    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:106

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    reversebooleanfalse
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    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:676

    +

    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:223

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onContextMenu#

    +

    onContextMenu(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:204

    +

    Returns: void

    +
    +

    onKeyDown#

    +

    onKeyDown(evt: KeyboardEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:177

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    onScrollOutside#

    +

    onScrollOutside(evt: UIEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:213

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtUIEvent
    +

    Returns: void

    +
    +

    onWindowResize#

    +

    onWindowResize(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:208

    +

    Returns: void

    +
    +

    open#

    +

    open(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:161

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu.tsx:243

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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:173

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.menuactions/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.menuactions/index.html new file mode 100644 index 0000000000..f7a3aa4474 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -0,0 +1,1731 @@ + + + + + + + + + + + + + + + + + + + + + + Class: MenuActions ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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› | MenuActionsProps): MenuActions

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuActionsProps› | MenuActionsProps
    +

    Returns: MenuActions

    +

    + new MenuActions(props: MenuActionsProps, context: any): MenuActions

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuActionsProps
    contextany
    +

    Returns: MenuActions

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:31

    +
    +

    isOpen#

    +

    isOpen: boolean = !!this.props.toolbar

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:33

    +
    +

    props#

    +

    props: Readonly‹MenuActionsProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:41

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:82

    +

    Returns: Element‹›

    +
    +

    renderTriggerIcon#

    +

    renderTriggerIcon(): Element‹›

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:55

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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:35

    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:25

    +

    removeConfirmationMessage#

    +

    removeConfirmationMessage:

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:26

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.menuitem/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.menuitem/index.html new file mode 100644 index 0000000000..3cecd94aaa --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -0,0 +1,1721 @@ + + + + + + + + + + + + + + + + + + + + + + Class: MenuItem ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: MenuItem ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    MenuItem

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new MenuItem(props: Readonly‹MenuItemProps› | MenuItemProps): MenuItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuItemProps› | MenuItemProps
    +

    Returns: MenuItem

    +

    + new MenuItem(props: MenuItemProps, context: any): MenuItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuItemProps
    contextany
    +

    Returns: MenuItem

    +

    Properties#

    +

    context#

    +

    context: MenuContextValue

    +

    Overrides PageLayout.context

    +

    Defined in src/renderer/components/menu/menu.tsx:314

    +
    +

    elem#

    +

    elem: HTMLElement

    +

    Defined in src/renderer/components/menu/menu.tsx:315

    +
    +

    props#

    +

    props: Readonly‹MenuItemProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static contextType#

    +

    contextType: Context‹Menu‹›› = MenuContext

    +

    Overrides PageLayout.contextType

    +

    Defined in src/renderer/components/menu/menu.tsx:312

    +
    +

    Static defaultProps#

    +

    defaultProps: object = defaultPropsMenuItem as object

    +

    Defined in src/renderer/components/menu/menu.tsx:311

    +

    Accessors#

    +

    isFocusable#

    +

    get isFocusable(): boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:317

    +

    Returns: boolean

    +
    + +

    get isLink(): boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:323

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:339

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:327

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu.tsx:343

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html new file mode 100644 index 0000000000..b1b66cf3bf --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html @@ -0,0 +1,1691 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceSelect ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: NamespaceSelect ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    +
      +
    • Component‹Props›
    • +
    +

    NamespaceSelect

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NamespaceSelect(props: Readonly‹Props› | Props): NamespaceSelect

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹Props› | Props
    +

    Returns: NamespaceSelect

    +

    + new NamespaceSelect(props: Props, context: any): NamespaceSelect

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsProps
    contextany
    +

    Returns: NamespaceSelect

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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‹Props› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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/+namespaces/namespace-select.tsx:26

    +

    Accessors#

    +

    options#

    +

    get options(): SelectOption[]

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:36

    +

    Returns: SelectOption[]

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    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‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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‹Props›
    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:640

    +

    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/+namespaces/namespace-select.tsx:28

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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‹Props›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    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‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    formatOptionLabel#

    +

    formatOptionLabel(option: SelectOption): object

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionSelectOption
    +

    Returns: object

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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‹Props›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/+namespaces/namespace-select.tsx:65

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.notifications/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.notifications/index.html new file mode 100644 index 0000000000..f6bb4a9461 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -0,0 +1,1762 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Notifications ‹**P, S, SS, P, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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› | P): Notifications

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹P› | P
    +

    Returns: Notifications

    +

    + new Notifications(props: P, context: any): Notifications

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsP
    contextany
    +

    Returns: Notifications

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html new file mode 100644 index 0000000000..6daea877eb --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -0,0 +1,1143 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NotificationsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.tsx:28

    +
    +

    notifications#

    +

    notifications: IObservableArray‹Notification = observable.array([], { deep: false })

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:26

    +

    Methods#

    +

    add#

    +

    add(notification: Notification): function

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:55

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    notificationNotification
    +

    Returns: function

    +

    ▸ (): void

    +
    +

    addAutoHideTimer#

    +

    addAutoHideTimer(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:34

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    +
    +

    getById#

    +

    getById(id: NotificationId): Notification | null

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:30

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: Notification | null

    +
    +

    remove#

    +

    remove(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:72

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    +
    +

    removeAutoHideTimer#

    +

    removeAutoHideTimer(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:47

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.pagelayout/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.pagelayout/index.html new file mode 100644 index 0000000000..8e71b651f3 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -0,0 +1,1681 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PageLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: PageLayout ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    PageLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PageLayout(props: Readonly‹PageLayoutProps› | PageLayoutProps): PageLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹PageLayoutProps› | PageLayoutProps
    +

    Returns: PageLayout

    +

    + new PageLayout(props: PageLayoutProps, context: any): PageLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsPageLayoutProps
    contextany
    +

    Returns: PageLayout

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html new file mode 100644 index 0000000000..e18bcaafd5 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html @@ -0,0 +1,1757 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDetailsList ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: PodDetailsList ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    +
      +
    • Component‹Props›
    • +
    +

    PodDetailsList

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodDetailsList(props: Readonly‹Props› | Props): PodDetailsList

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹Props› | Props
    +

    Returns: PodDetailsList

    +

    + new PodDetailsList(props: Props, context: any): PodDetailsList

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsProps
    contextany
    +

    Returns: PodDetailsList

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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‹Props› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    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‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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‹Props›
    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:640

    +

    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/+workloads-pods/pod-details-list.tsx:53

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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‹Props›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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‹Props›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    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‹Props›
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:60

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹Props›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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‹Props›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    getTableRow#

    +

    getTableRow(uid: string): Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    uidstring
    +

    Returns: Element‹›

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:125

    +

    Returns: Element‹›

    +
    +

    renderCpuUsage#

    +

    renderCpuUsage(id: string, usage: number): string | 0 | Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:64

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    usagenumber
    +

    Returns: string | 0 | Element‹›

    +
    +

    renderMemoryUsage#

    +

    renderMemoryUsage(id: string, usage: number): string | 0 | Element‹›

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:85

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    usagenumber
    +

    Returns: string | 0 | Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof S

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹Props›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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‹Props›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:38

    +

    showTitle#

    +

    showTitle: true = true

    +

    Defined in src/renderer/components/+workloads-pods/pod-details-list.tsx:39

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.radio/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.radio/index.html new file mode 100644 index 0000000000..b95b371f7a --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -0,0 +1,1657 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Radio ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Radio ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Radio

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Radio(props: Readonly‹RadioProps› | RadioProps): Radio

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹RadioProps› | RadioProps
    +

    Returns: Radio

    +

    + new Radio(props: RadioProps, context: any): Radio

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsRadioProps
    contextany
    +

    Returns: Radio

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.radiogroup/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.radiogroup/index.html new file mode 100644 index 0000000000..c87c53532b --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RadioGroup ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: RadioGroup ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    RadioGroup

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RadioGroup(props: Readonly‹RadioGroupProps› | RadioGroupProps): RadioGroup

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹RadioGroupProps› | RadioGroupProps
    +

    Returns: RadioGroup

    +

    + new RadioGroup(props: RadioGroupProps, context: any): RadioGroup

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsRadioGroupProps
    contextany
    +

    Returns: RadioGroup

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.select/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.select/index.html new file mode 100644 index 0000000000..3c5624e2b1 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.select/index.html @@ -0,0 +1,1838 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Select ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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› | SelectProps): Select

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SelectProps› | SelectProps
    +

    Returns: Select

    +

    + new Select(props: SelectProps, context: any): Select

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSelectProps
    contextany
    +

    Returns: Select

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.slider/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.slider/index.html new file mode 100644 index 0000000000..22a94abaed --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -0,0 +1,1628 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Slider ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Slider ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Slider

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Slider(props: Readonly‹SliderProps› | SliderProps): Slider

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SliderProps› | SliderProps
    +

    Returns: Slider

    +

    + new Slider(props: SliderProps, context: any): Slider

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSliderProps
    contextany
    +

    Returns: Slider

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.spinner/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.spinner/index.html new file mode 100644 index 0000000000..3999ac95b2 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -0,0 +1,1676 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Spinner ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Spinner ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Spinner

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Spinner(props: Readonly‹SpinnerProps› | SpinnerProps): Spinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SpinnerProps› | SpinnerProps
    +

    Returns: Spinner

    +

    + new Spinner(props: SpinnerProps, context: any): Spinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSpinnerProps
    contextany
    +

    Returns: Spinner

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.statusbrick/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.statusbrick/index.html new file mode 100644 index 0000000000..ab98608002 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatusBrick ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: StatusBrick ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    StatusBrick

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StatusBrick(props: Readonly‹StatusBrickProps› | StatusBrickProps): StatusBrick

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹StatusBrickProps› | StatusBrickProps
    +

    Returns: StatusBrick

    +

    + new StatusBrick(props: StatusBrickProps, context: any): StatusBrick

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsStatusBrickProps
    contextany
    +

    Returns: StatusBrick

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.stepper/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.stepper/index.html new file mode 100644 index 0000000000..52fd415f64 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Stepper ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Stepper ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Stepper

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Stepper(props: Readonly‹StepperProps› | StepperProps): Stepper

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹StepperProps› | StepperProps
    +

    Returns: Stepper

    +

    + new Stepper(props: StepperProps, context: any): Stepper

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsStepperProps
    contextany
    +

    Returns: Stepper

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.tab/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.tab/index.html new file mode 100644 index 0000000000..75bdfb4cbd --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tab ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:65

    +
    +

    elem#

    +

    elem: HTMLElement

    +

    Defined in src/renderer/components/tabs/tabs.tsx:66

    +
    +

    Static contextType#

    +

    contextType: Context‹TabsContextValue‹any›› = TabsContext

    +

    Defined in src/renderer/components/tabs/tabs.tsx:64

    +

    Accessors#

    +

    isActive#

    +

    get isActive(): boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:68

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:121

    +

    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:640

    +

    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:114

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:74

    +

    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:676

    +

    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:86

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    onFocus#

    +

    onFocus(evt: FocusEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:96

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtFocusEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:104

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Defined in src/renderer/components/tabs/tabs.tsx:125

    +

    Returns: Element‹›

    +
    +

    scrollIntoView#

    +

    scrollIntoView(): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:78

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.table/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.table/index.html new file mode 100644 index 0000000000..682567cf5f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.table/index.html @@ -0,0 +1,1841 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Table ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Table ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Table

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Table(props: Readonly‹TableProps› | TableProps): Table

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableProps› | TableProps
    +

    Returns: Table

    +

    + new Table(props: TableProps, context: any): Table

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableProps
    contextany
    +

    Returns: Table

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    sortParams#

    +

    sortParams: Partial‹TableSortParams = Object.assign( + this.props.sortSyncWithUrl ? { + sortBy: sortByUrlParam.get(), + orderBy: orderByUrlParam.get(), + } : {}, + this.props.sortByDefault, + )

    +

    Defined in src/renderer/components/table/table.tsx:64

    +
    +

    state#

    +

    state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:106

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsany[]
    +

    Returns: any[]

    +
    +

    Protected onSort#

    +

    onSort(__namedParameters: object): void

    +

    Defined in src/renderer/components/table/table.tsx:114

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    orderBystring
    sortBystring
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table.tsx:186

    +

    Returns: Element‹›

    +
    +

    renderHead#

    +

    renderHead(): ReactElement‹TableHeadProps‹›, string | function | object›

    +

    Defined in src/renderer/components/table/table.tsx:72

    +

    Returns: ReactElement‹TableHeadProps‹›, string | function | object›

    +
    +

    renderRows#

    +

    renderRows(): object

    +

    Defined in src/renderer/components/table/table.tsx:141

    +

    Returns: object

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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:129

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    colNameTableSortBy
    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/table/table.tsx:56

    +

    autoSize#

    +

    autoSize: true = true

    +

    Defined in src/renderer/components/table/table.tsx:58

    +

    rowLineHeight#

    +

    rowLineHeight: string = "17px"

    +

    Defined in src/renderer/components/table/table.tsx:60

    +

    rowPadding#

    +

    rowPadding: string = "8px"

    +

    Defined in src/renderer/components/table/table.tsx:59

    +

    scrollable#

    +

    scrollable: true = true

    +

    Defined in src/renderer/components/table/table.tsx:57

    +

    sortSyncWithUrl#

    +

    sortSyncWithUrl: true = true

    +

    Defined in src/renderer/components/table/table.tsx:61

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.tablecell/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.tablecell/index.html new file mode 100644 index 0000000000..e97550454c --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -0,0 +1,1706 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableCell ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: TableCell ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    TableCell

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new TableCell(props: Readonly‹TableCellProps› | TableCellProps): TableCell

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableCellProps› | TableCellProps
    +

    Returns: TableCell

    +

    + new TableCell(props: TableCellProps, context: any): TableCell

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableCellProps
    contextany
    +

    Returns: TableCell

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:37

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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:27

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent‹HTMLDivElement›
    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table-cell.tsx:67

    +

    Returns: Element‹›

    +
    +

    renderCheckbox#

    +

    renderCheckbox(): Element‹›

    +

    Defined in src/renderer/components/table/table-cell.tsx:58

    +

    Returns: Element‹›

    +
    +

    renderSortIcon#

    +

    renderSortIcon(): Element‹›

    +

    Defined in src/renderer/components/table/table-cell.tsx:43

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.tablehead/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.tablehead/index.html new file mode 100644 index 0000000000..405ecb32bd --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -0,0 +1,1668 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableHead ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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› | TableHeadProps): TableHead

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableHeadProps› | TableHeadProps
    +

    Returns: TableHead

    +

    + new TableHead(props: TableHeadProps, context: any): TableHead

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableHeadProps
    contextany
    +

    Returns: TableHead

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.tablerow/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.tablerow/index.html new file mode 100644 index 0000000000..eb8a10111d --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableRow ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: TableRow ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    TableRow

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new TableRow(props: Readonly‹TableRowProps› | TableRowProps): TableRow

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableRowProps› | TableRowProps
    +

    Returns: TableRow

    +

    + new TableRow(props: TableRowProps, context: any): TableRow

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableRowProps
    contextany
    +

    Returns: TableRow

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.tabs/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.tabs/index.html new file mode 100644 index 0000000000..abe7cbc831 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -0,0 +1,1445 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tabs ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:676

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.tooltip/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.tooltip/index.html new file mode 100644 index 0000000000..15ea535350 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -0,0 +1,1860 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tooltip ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: Tooltip ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    Tooltip

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Tooltip(props: Readonly‹TooltipProps› | TooltipProps): Tooltip

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TooltipProps› | TooltipProps
    +

    Returns: Tooltip

    +

    + new Tooltip(props: TooltipProps, context: any): Tooltip

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTooltipProps
    contextany
    +

    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:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.wizard/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.wizard/index.html new file mode 100644 index 0000000000..1b4188f47a --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.wizard/index.html @@ -0,0 +1,1827 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Wizard ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    + +
    + + + +
    +
    + + + +

    Class: Wizard ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    Wizard

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Wizard(props: Readonly‹WizardProps› | WizardProps): Wizard

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardProps› | WizardProps
    +

    Returns: Wizard

    +

    + new Wizard(props: WizardProps, context: any): Wizard

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardProps
    contextany
    +

    Returns: Wizard

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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‹WizardProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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#

    +

    step#

    +

    get step(): number

    +

    Defined in src/renderer/components/wizard/wizard.tsx:56

    +

    Returns: number

    +

    set step(step: number): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:60

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    stepnumber
    +

    Returns: void

    +
    +

    steps#

    +

    get steps(): ReactElement‹WizardStepProps‹any›, string | function | object›[]

    +

    Defined in src/renderer/components/wizard/wizard.tsx:34

    +

    Returns: ReactElement‹WizardStepProps‹any›, string | function | object›[]

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:711

    +

    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‹WizardProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    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‹WizardProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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‹WizardProps
    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:640

    +

    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:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹WizardProps›, prevState: Readonly‹State›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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‹WizardProps
    prevStateReadonly‹State›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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‹WizardProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    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‹WizardProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:635

    +

    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‹WizardProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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‹WizardProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    firstStep#

    +

    firstStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:77

    +

    Returns: any

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹WizardProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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‹WizardProps
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    Protected getValidStep#

    +

    getValidStep(step: number): number

    +

    Defined in src/renderer/components/wizard/wizard.tsx:71

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    stepnumber
    +

    Returns: number

    +
    +

    isFirstStep#

    +

    isFirstStep(): boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:75

    +

    Returns: boolean

    +
    +

    isLastStep#

    +

    isLastStep(): boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:76

    +

    Returns: boolean

    +
    +

    lastStep#

    +

    lastStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:80

    +

    Returns: any

    +
    +

    nextStep#

    +

    nextStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:78

    +

    Returns: any

    +
    +

    prevStep#

    +

    prevStep(): any

    +

    Defined in src/renderer/components/wizard/wizard.tsx:79

    +

    Returns: any

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:82

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof State

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹WizardProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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‹WizardProps
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    state#

    +

    state: object#

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/wizard/wizard.tsx:30

    +

    step#

    +

    step: number = this.getValidStep(this.props.step)

    +

    Defined in src/renderer/components/wizard/wizard.tsx:31

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html new file mode 100644 index 0000000000..d2c7494b82 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WizardLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: WizardLayout ‹S, SS, S#

    +

    Type parameters#

    +

    S

    +

    SS

    +

    S

    +

    Hierarchy#

    + +

    WizardLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new WizardLayout(props: Readonly‹WizardLayoutProps› | WizardLayoutProps): WizardLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardLayoutProps› | WizardLayoutProps
    +

    Returns: WizardLayout

    +

    + new WizardLayout(props: WizardLayoutProps, context: any): WizardLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardLayoutProps
    contextany
    +

    Returns: WizardLayout

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    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:499

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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:743

    +

    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:771

    +

    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:640

    +

    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:619

    +

    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:682

    +

    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:697

    +

    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:726

    +

    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:635

    +

    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:756

    +

    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:490

    +

    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:676

    +

    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#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    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:630

    +

    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.1.0/extensions/api/classes/_renderer_api_components_.wizardstep/index.html b/v4.1.0/extensions/api/classes/_renderer_api_components_.wizardstep/index.html new file mode 100644 index 0000000000..81f6262c73 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_components_.wizardstep/index.html @@ -0,0 +1,1716 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WizardStep ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Class: WizardStep ‹SS#

    +

    Type parameters#

    +

    SS

    +

    Hierarchy#

    + +

    WizardStep

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new WizardStep(props: Readonly‹WizardStepProps› | WizardStepProps): WizardStep

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardStepProps› | WizardStepProps
    +

    Returns: WizardStep

    +

    + new WizardStep(props: WizardStepProps, context: any): WizardStep

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:475

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardStepProps
    contextany
    +

    Returns: WizardStep

    +

    Properties#

    +

    context#

    +

    context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:473

    +

    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‹WizardStepProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +
    +

    refs#

    +

    refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:504

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
    • +
    +
    +

    state#

    +

    state: WizardStepState

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/wizard/wizard.tsx:136

    +
    +

    Static Optional contextType#

    +

    contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:455

    +

    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:711

    +

    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‹WizardStepProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:743

    +

    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‹WizardStepProps
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:771

    +

    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‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:640

    +

    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:619

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    componentDidUpdate(prevProps: Readonly‹WizardStepProps›, prevState: Readonly‹WizardStepState›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:682

    +

    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‹WizardStepProps
    prevStateReadonly‹WizardStepState›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:697

    +

    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‹WizardStepProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:726

    +

    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‹WizardStepProps
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/wizard/wizard.tsx:143

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    componentWillUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:756

    +

    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‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:490

    +

    Parameters:

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    getSnapshotBeforeUpdate(prevProps: Readonly‹WizardStepProps›, prevState: Readonly‹WizardStepState›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:676

    +

    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‹WizardStepProps
    prevStateReadonly‹WizardStepState›
    +

    Returns: SS | null

    +
    +

    next#

    +

    next(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:154

    +

    Returns: void

    +
    +

    prev#

    +

    prev(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:147

    +

    Returns: void

    +
    +

    render#

    +

    render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:194

    +

    Returns: Element‹›

    +
    +

    renderLoading#

    +

    renderLoading(): Element‹›

    +

    Defined in src/renderer/components/wizard/wizard.tsx:186

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    setStateK›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:485

    +

    Type parameters:

    +

    K: keyof WizardStepState

    +

    Parameters:

    +

    state: function | S | object

    +

    Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    shouldComponentUpdate(nextProps: Readonly‹WizardStepProps›, nextState: Readonly‹WizardStepState›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:630

    +

    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‹WizardStepProps
    nextStateReadonly‹WizardStepState›
    nextContextany
    +

    Returns: boolean

    +
    +

    submit#

    +

    submit(): void

    +

    Defined in src/renderer/components/wizard/wizard.tsx:177

    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    defaultProps: object#

    +

    Defined in src/renderer/components/wizard/wizard.tsx:139

    +

    scrollable#

    +

    scrollable: true = true

    +

    Defined in src/renderer/components/wizard/wizard.tsx:140

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html new file mode 100644 index 0000000000..515442cade --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html @@ -0,0 +1,1598 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterRole - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ClusterRole

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    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:166

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html new file mode 100644 index 0000000000..5e4f457893 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html @@ -0,0 +1,1637 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterRoleBinding - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ClusterRoleBinding

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html new file mode 100644 index 0000000000..319afdc344 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html @@ -0,0 +1,1601 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMap - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:99

    +
    +

    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:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    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:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html new file mode 100644 index 0000000000..dadddf793e --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMapsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ConfigMapsStore#

    +

    Hierarchy#

    +

    KubeObjectStoreConfigMap

    +

    ConfigMapsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ConfigMapsStore(): ConfigMapsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ConfigMapsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiConfigMap‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): ConfigMap[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: ConfigMap[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ConfigMap[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): ConfigMap[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ConfigMap

    +
    +

    getByPath#

    +

    getByPath(path: string): ConfigMap

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ConfigMap

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ConfigMap[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ConfigMap[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: ConfigMap[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsConfigMap[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: ConfigMap): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: ConfigMap[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ConfigMap

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | ConfigMap[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ConfigMap[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ConfigMap

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹ConfigMap[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹ConfigMap[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ConfigMap[], __namedParameters: object): ConfigMap[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: ConfigMap[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ConfigMap[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: ConfigMap): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsConfigMap[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ConfigMap[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: ConfigMap[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsConfigMap[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    dataPartial‹ConfigMap
    +

    Returns: Promise‹ConfigMap

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: ConfigMap, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: ConfigMap

    +

    request: function

    +

    ▸ (): Promise‹ConfigMap

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html new file mode 100644 index 0000000000..5163ee54da --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html @@ -0,0 +1,2368 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CRDResourceStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): T[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: T[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: T[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): T[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: T

    +
    +

    getByPath#

    +

    getByPath(path: string): T

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: T

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): T[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: T[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: T[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: T): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: T[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹T[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹T[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: T[], __namedParameters: object): T[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: T[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: T[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: T): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: T): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsT[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: T[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: T): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: T[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: T): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemT
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: T, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: T

    +

    request: function

    +

    ▸ (): Promise‹T›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html new file mode 100644 index 0000000000..5db30ce7e1 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html @@ -0,0 +1,2405 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CRDStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CRDStore#

    +

    Hierarchy#

    +

    KubeObjectStoreCustomResourceDefinition

    +

    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: KubeApiCustomResourceDefinition‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: CustomResourceDefinition[]

    +
    +

    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:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    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‹›

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    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:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: CustomResourceDefinition

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: CustomResourceDefinition[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: CustomResourceDefinition[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCustomResourceDefinition[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: CustomResourceDefinition): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CustomResourceDefinition

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | CustomResourceDefinition[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | CustomResourceDefinition[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CustomResourceDefinition

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹CustomResourceDefinition[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹CustomResourceDefinition[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: CustomResourceDefinition[], __namedParameters: object): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: CustomResourceDefinition[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: CustomResourceDefinition[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: CustomResourceDefinition): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCustomResourceDefinition[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    dataPartial‹CustomResourceDefinition
    +

    Returns: Promise‹CustomResourceDefinition

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: CustomResourceDefinition, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: CustomResourceDefinition

    +

    request: function

    +

    ▸ (): Promise‹CustomResourceDefinition

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html new file mode 100644 index 0000000000..a96b2423b3 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html @@ -0,0 +1,1752 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CronJob - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: CronJob

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Overrides KubeObject.apiVersion

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:47

    +
    +

    kind#

    +

    kind: string

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:46

    +
    +

    metadata#

    +

    metadata: object

    +

    Overrides KubeObject.metadata

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:48

    +

    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:62

    +

    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:95

    +

    Type declaration:

    +
      +
    • lastScheduleTime? : string
    • +
    +
    +

    Static apiBase#

    +

    apiBase: string = "/apis/batch/v1beta1/cronjobs"

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:44

    +
    +

    Static kind#

    +

    kind: string = "CronJob"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:42

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:43

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getLastScheduleTime#

    +

    getLastScheduleTime(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:103

    +

    Returns: string

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSchedule#

    +

    getSchedule(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:110

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    Returns: string[]

    +
    +

    getSuspendFlag#

    +

    getSuspendFlag(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:99

    +

    Returns: string

    +
    +

    isNeverRun#

    +

    isNeverRun(): boolean

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:114

    +

    Returns: boolean

    +
    +

    isSuspend#

    +

    isSuspend(): boolean

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:126

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html new file mode 100644 index 0000000000..82f36edc8b --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html @@ -0,0 +1,2380 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CronJobStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CronJobStore#

    +

    Hierarchy#

    +

    KubeObjectStoreCronJob

    +

    CronJobStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CronJobStore(): CronJobStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: CronJobStore

    +

    Properties#

    +

    api#

    +

    api: CronJobApi‹› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): CronJob[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: CronJob[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹CronJob›): Promise‹CronJob

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: CronJob[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): CronJob[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: CronJob

    +
    +

    getByPath#

    +

    getByPath(path: string): CronJob

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: CronJob

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): CronJob[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    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

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: CronJob): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: CronJob[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CronJob

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | CronJob[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | CronJob[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CronJob

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹CronJob[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹CronJob[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: CronJob[], __namedParameters: object): CronJob[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: CronJob[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: CronJob[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: CronJob): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: CronJob): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsCronJob[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: CronJob[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: CronJob): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: CronJob[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCronJob[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: CronJob): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemCronJob
    dataPartial‹CronJob
    +

    Returns: Promise‹CronJob

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: CronJob, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: CronJob

    +

    request: function

    +

    ▸ (): Promise‹CronJob

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html new file mode 100644 index 0000000000..5065881c26 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html @@ -0,0 +1,1882 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CustomResourceDefinition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: CustomResourceDefinition

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    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:139

    +

    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:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    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:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    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:112

    +

    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:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html new file mode 100644 index 0000000000..e60621ed8f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html @@ -0,0 +1,1788 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    + +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: DaemonSet

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    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:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    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:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html new file mode 100644 index 0000000000..c034ed719b --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html @@ -0,0 +1,2423 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DaemonSetStore#

    +

    Hierarchy#

    +

    KubeObjectStoreDaemonSet

    +

    DaemonSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DaemonSetStore(): DaemonSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: DaemonSetStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiDaemonSet‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    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

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): DaemonSet[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: DaemonSet[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: DaemonSet[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): DaemonSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: DaemonSet

    +
    +

    getByPath#

    +

    getByPath(path: string): DaemonSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    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[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): DaemonSet[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: DaemonSet[]

    +
    +

    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

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: DaemonSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: DaemonSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹DaemonSet

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | DaemonSet[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | DaemonSet[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹DaemonSet

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹DaemonSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    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 mergeItems#

    +

    mergeItems(partialItems: DaemonSet[], __namedParameters: object): DaemonSet[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: DaemonSet[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: DaemonSet[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: DaemonSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsDaemonSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: DaemonSet[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: DaemonSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDaemonSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    dataPartial‹DaemonSet
    +

    Returns: Promise‹DaemonSet

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: DaemonSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: DaemonSet

    +

    request: function

    +

    ▸ (): Promise‹DaemonSet

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html new file mode 100644 index 0000000000..68166faed3 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html @@ -0,0 +1,1853 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Deployment - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Deployment

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:75

    +

    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:154

    +

    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:73

    +
    +

    Static kind#

    +

    kind: string = "Deployment"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:71

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:72

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    getConditions(activeOnly: boolean): object[]

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:171

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    activeOnlybooleanfalse
    +

    Returns: object[]

    +
    +

    getConditionsText#

    +

    getConditionsText(activeOnly: boolean): string

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:183

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    activeOnlybooleantrue
    +

    Returns: string

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    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:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getReplicas#

    +

    getReplicas(): number

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:187

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html new file mode 100644 index 0000000000..ed47a76916 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html @@ -0,0 +1,1866 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Deployment
    +

    Returns: DeploymentApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹Deployment

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹Deployment

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:329

    +

    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:356

    +

    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:321

    +

    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:242

    +

    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:250

    +

    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:363

    +

    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:313

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Deployment[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:446

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    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:274

    +

    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:246

    +

    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:238

    +

    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:347

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Deployment

    +

    Returns: Promise‹Deployment

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:371

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html new file mode 100644 index 0000000000..d607039073 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html @@ -0,0 +1,2411 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DeploymentStore#

    +

    Hierarchy#

    +

    KubeObjectStoreDeployment

    +

    DeploymentStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DeploymentStore(): DeploymentStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    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

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Deployment[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Deployment[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Deployment›): Promise‹Deployment

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Deployment[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Deployment[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Deployment

    +
    +

    getByPath#

    +

    getByPath(path: string): Deployment

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    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‹›[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Deployment[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Deployment[]

    +
    +

    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

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Deployment): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Deployment[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Deployment

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Deployment[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Deployment[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Deployment

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Deployment[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    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 mergeItems#

    +

    mergeItems(partialItems: Deployment[], __namedParameters: object): Deployment[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Deployment[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Deployment[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Deployment): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Deployment): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Deployment): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Deployment[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDeployment[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Deployment): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemDeployment
    dataPartial‹Deployment
    +

    Returns: Promise‹Deployment

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Deployment, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Deployment

    +

    request: function

    +

    ▸ (): Promise‹Deployment

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html new file mode 100644 index 0000000000..6c0e53481f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html @@ -0,0 +1,1610 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Endpoint - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Endpoint

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    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:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    toString#

    +

    toString(): string

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:117

    +

    Returns: string

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html new file mode 100644 index 0000000000..afb436fbb5 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: EndpointStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: EndpointStore#

    +

    Hierarchy#

    +

    KubeObjectStoreEndpoint

    +

    EndpointStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new EndpointStore(): EndpointStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: EndpointStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiEndpoint‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Endpoint[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Endpoint[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Endpoint[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Endpoint[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Endpoint

    +
    +

    getByPath#

    +

    getByPath(path: string): Endpoint

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Endpoint

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Endpoint[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Endpoint[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Endpoint[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsEndpoint[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Endpoint): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Endpoint[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Endpoint

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Endpoint[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Endpoint[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Endpoint

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Endpoint[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Endpoint[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Endpoint[], __namedParameters: object): Endpoint[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Endpoint[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Endpoint[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Endpoint): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Endpoint): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsEndpoint[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Endpoint[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Endpoint): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Endpoint[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsEndpoint[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Endpoint): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    dataPartial‹Endpoint
    +

    Returns: Promise‹Endpoint

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Endpoint, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Endpoint

    +

    request: function

    +

    ▸ (): Promise‹Endpoint

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html new file mode 100644 index 0000000000..e2103a19b9 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html @@ -0,0 +1,2381 @@ + + + + + + + + + + + + + + + + + + + + + + Class: EventStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: EventStore#

    +

    Hierarchy#

    +

    KubeObjectStoreKubeEvent

    +

    EventStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new EventStore(): EventStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: EventStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiKubeEvent‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): KubeEvent[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: KubeEvent[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(): void

    +

    Overrides KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/components/+events/event.store.ts:17

    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: KubeEvent[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): KubeEvent[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: KubeEvent

    +
    +

    getByPath#

    +

    getByPath(path: string): KubeEvent

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    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[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): KubeEvent[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: KubeEvent[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: KubeEvent[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsKubeEvent[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    getWarnings#

    +

    getWarnings(): KubeEvent‹›[]

    +

    Defined in src/renderer/components/+events/event.store.ts:37

    +

    Returns: KubeEvent‹›[]

    +
    +

    getWarningsCount#

    +

    getWarningsCount(): number

    +

    Defined in src/renderer/components/+events/event.store.ts:56

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: KubeEvent): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: KubeEvent[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹KubeEvent

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | KubeEvent[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | KubeEvent[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹KubeEvent

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹KubeEvent[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹KubeEvent[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: KubeEvent[], __namedParameters: object): KubeEvent[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: KubeEvent[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: KubeEvent[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: KubeEvent): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: KubeEvent[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsKubeEvent[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    dataPartial‹KubeEvent
    +

    Returns: Promise‹KubeEvent

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: KubeEvent, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: KubeEvent

    +

    request: function

    +

    ▸ (): Promise‹KubeEvent

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html new file mode 100644 index 0000000000..32ae1f8d1f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html @@ -0,0 +1,1757 @@ + + + + + + + + + + + + + + + + + + + + + + Class: HorizontalPodAutoscaler - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    + +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: HorizontalPodAutoscaler

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    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:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    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:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    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:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html new file mode 100644 index 0000000000..41a47bb2a1 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: HPAStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: HPAStore#

    +

    Hierarchy#

    +

    KubeObjectStoreHorizontalPodAutoscaler

    +

    HPAStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new HPAStore(): HPAStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: HPAStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiHorizontalPodAutoscaler‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: HorizontalPodAutoscaler

    +
    +

    getByPath#

    +

    getByPath(path: string): HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: HorizontalPodAutoscaler

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: HorizontalPodAutoscaler[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsHorizontalPodAutoscaler[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: HorizontalPodAutoscaler): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: HorizontalPodAutoscaler[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹HorizontalPodAutoscaler

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | HorizontalPodAutoscaler[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | HorizontalPodAutoscaler[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹HorizontalPodAutoscaler

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹HorizontalPodAutoscaler[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹HorizontalPodAutoscaler[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: HorizontalPodAutoscaler[], __namedParameters: object): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: HorizontalPodAutoscaler[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: HorizontalPodAutoscaler): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsHorizontalPodAutoscaler[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: HorizontalPodAutoscaler[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsHorizontalPodAutoscaler[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    dataPartial‹HorizontalPodAutoscaler
    +

    Returns: Promise‹HorizontalPodAutoscaler

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: HorizontalPodAutoscaler, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: HorizontalPodAutoscaler

    +

    request: function

    +

    ▸ (): Promise‹HorizontalPodAutoscaler

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html new file mode 100644 index 0000000000..f5db62725f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html @@ -0,0 +1,1681 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Ingress - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Ingress

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    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:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    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:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    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:112

    +

    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:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html new file mode 100644 index 0000000000..45b040648e --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html @@ -0,0 +1,1765 @@ + + + + + + + + + + + + + + + + + + + + + + Class: IngressApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Ingress
    +

    Returns: IngressApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹Ingress

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹Ingress

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:329

    +

    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:356

    +

    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:321

    +

    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:242

    +

    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:250

    +

    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:363

    +

    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:313

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Ingress[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:446

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    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:274

    +

    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:246

    +

    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:238

    +

    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:347

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Ingress

    +

    Returns: Promise‹Ingress

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:371

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html new file mode 100644 index 0000000000..3e6764424a --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html @@ -0,0 +1,2384 @@ + + + + + + + + + + + + + + + + + + + + + + Class: IngressStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: IngressStore#

    +

    Hierarchy#

    +

    KubeObjectStoreIngress

    +

    IngressStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new IngressStore(): IngressStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    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

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Ingress[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Ingress[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Ingress›): Promise‹Ingress

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Ingress[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Ingress[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Ingress

    +
    +

    getByPath#

    +

    getByPath(path: string): Ingress

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Ingress

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Ingress[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Ingress[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Ingress[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsIngress[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Ingress): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Ingress[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Ingress

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Ingress[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Ingress[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Ingress

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Ingress[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    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 mergeItems#

    +

    mergeItems(partialItems: Ingress[], __namedParameters: object): Ingress[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Ingress[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Ingress[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Ingress): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Ingress): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsIngress[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Ingress[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Ingress): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Ingress[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsIngress[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Ingress): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemIngress
    dataPartial‹Ingress
    +

    Returns: Promise‹Ingress

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Ingress, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Ingress

    +

    request: function

    +

    ▸ (): Promise‹Ingress

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.job/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.job/index.html new file mode 100644 index 0000000000..8402e6b87f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.job/index.html @@ -0,0 +1,1839 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Job - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Job

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    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:126

    +

    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:147

    +

    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:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    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:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    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:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    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:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html new file mode 100644 index 0000000000..8ed5a19aad --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html @@ -0,0 +1,2414 @@ + + + + + + + + + + + + + + + + + + + + + + Class: JobStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: JobStore#

    +

    Hierarchy#

    +

    KubeObjectStoreJob

    +

    JobStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new JobStore(): JobStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: JobStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiJob‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Job[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Job[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Job›): Promise‹Job

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Job[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Job[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Job

    +
    +

    getByPath#

    +

    getByPath(path: string): Job

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    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[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Job[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Job[]

    +
    +

    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

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Job): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Job[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Job

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Job[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Job[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Job

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Job[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Job[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Job[], __namedParameters: object): Job[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Job[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Job[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Job): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Job): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsJob[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Job[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Job): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Job[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsJob[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Job): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemJob
    dataPartial‹Job
    +

    Returns: Promise‹Job

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Job, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Job

    +

    request: function

    +

    ▸ (): Promise‹Job

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html new file mode 100644 index 0000000000..f890f94bc1 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html @@ -0,0 +1,1716 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeApi ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹T›
    +

    Returns: KubeApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹T›

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹T›

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-api.ts:329

    +

    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:356

    +

    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:321

    +

    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:242

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Defined in src/renderer/api/kube-api.ts:250

    +

    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:363

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T[]›

    +

    Defined in src/renderer/api/kube-api.ts:313

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹T[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Defined in src/renderer/api/kube-api.ts:446

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Defined in src/renderer/api/kube-api.ts:274

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Defined in src/renderer/api/kube-api.ts:246

    +

    Parameters:

    +

    Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    setResourceVersion(namespace: string, newVersion: string): void

    +

    Defined in src/renderer/api/kube-api.ts:238

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    update(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-api.ts:347

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Defined in src/renderer/api/kube-api.ts:371

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html new file mode 100644 index 0000000000..0e83310927 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html @@ -0,0 +1,1789 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeEvent - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    + +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: KubeEvent

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    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:100

    +
    +

    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:101

    +
    +

    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:102

    +
    +

    type#

    +

    type: "Normal" | "Warning" | 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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    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:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    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:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html new file mode 100644 index 0000000000..724c2e0b9e --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html @@ -0,0 +1,1554 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObject - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObject#

    +

    Hierarchy#

    +
      +
    • KubeObject
    • +
    +

    Node

    +

    CronJob

    +

    ConfigMap

    +

    Secret

    +

    ResourceQuota

    +

    LimitRange

    +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: KubeObject

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : any

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static kind#

    +

    kind: string

    +

    Defined in src/renderer/api/kube-object.ts:70

    +
    +

    Static namespaced#

    +

    namespaced: boolean

    +

    Defined in src/renderer/api/kube-object.ts:71

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Defined in src/renderer/api/kube-object.ts:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    isJsonApiData(object: any): object is KubeJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Defined in src/renderer/api/kube-object.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html new file mode 100644 index 0000000000..e8973641df --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html @@ -0,0 +1,2348 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObjectStore ‹T#

    +

    Type parameters#

    +

    T: KubeObject

    +

    Hierarchy#

    +
      +
    • ItemStore‹T›
    • +
    +

    KubeObjectStore

    +

    EventStore

    +

    PodsStore

    +

    NodesStore

    +

    DeploymentStore

    +

    DaemonSetStore

    +

    StatefulSetStore

    +

    JobStore

    +

    CronJobStore

    +

    ConfigMapsStore

    +

    SecretsStore

    +

    ReplicaSetStore

    +

    ResourceQuotasStore

    +

    LimitRangesStore

    +

    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:26

    +

    Returns: KubeObjectStore

    +

    Properties#

    +

    Abstract api#

    +

    api: KubeApi‹T›

    +

    Defined in src/renderer/kube-object.store.ts:21

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): T[]

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: T[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): T[]

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: T[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): T[]

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: T[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): T

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: T

    +
    +

    getByPath#

    +

    getByPath(path: string): T

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: T

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): T[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: T[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: T[]): Record‹string, number›

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: T): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: T[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | T[]›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹T›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹T[]›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹T[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: T[], __namedParameters: object): T[]

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: T[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: T[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: T): Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    Parameters:

    +

    item: T

    +

    request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    removeSelectedItems(): Promise‹void[]›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: T): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsT[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: T[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: T): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: T[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: T): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    update#

    +

    update(item: T, data: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemT
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: T, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: T

    +

    request: function

    +

    ▸ (): Promise‹T›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html new file mode 100644 index 0000000000..50116a784f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html @@ -0,0 +1,1627 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LimitRange - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LimitRange#

    +

    Hierarchy#

    + +

    LimitRange

    +

    Implements#

    +
      +
    • ItemObject
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LimitRange(data: KubeJsonApiData): LimitRange

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: LimitRange

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:38

    +

    Type declaration:

    +
      +
    • limits: LimitRangeItem[]
    • +
    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    Static apiBase#

    +

    apiBase: string = "/api/v1/limitranges"

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:36

    +
    +

    Static kind#

    +

    kind: string = "LimitRange"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:34

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:35

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getContainerLimits#

    +

    getContainerLimits(): LimitRangeItem‹›[]

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:42

    +

    Returns: LimitRangeItem‹›[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getPVCLimits#

    +

    getPVCLimits(): LimitRangeItem‹›[]

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:50

    +

    Returns: LimitRangeItem‹›[]

    +
    +

    getPodLimits#

    +

    getPodLimits(): LimitRangeItem‹›[]

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:46

    +

    Returns: LimitRangeItem‹›[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html new file mode 100644 index 0000000000..be889b171f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LimitRangesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LimitRangesStore#

    +

    Hierarchy#

    +

    KubeObjectStoreLimitRange

    +

    LimitRangesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LimitRangesStore(): LimitRangesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: LimitRangesStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiLimitRange‹›› = limitRangeApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-limit-ranges/limit-ranges.store.ts:8

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: LimitRange[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    get selectedItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: LimitRange[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹LimitRange

    +

    Returns: Promise‹LimitRange

    +
    +

    Protected createItem#

    +

    createItem(params: object, data?: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:226

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Optional data: Partial‹LimitRange

    +

    Returns: Promise‹LimitRange

    +
    +

    Protected defaultSorting#

    +

    defaultSorting(item: LimitRange): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    filterItemsOnLoad(items: LimitRange[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsLimitRange[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    getAllByNs(namespace: string | string[], strict: boolean): LimitRange[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: LimitRange[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): LimitRange[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: LimitRange[]

    +
    +

    getByName#

    +

    getByName(name: string, namespace?: string): LimitRange

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: LimitRange

    +
    +

    getByPath#

    +

    getByPath(path: string): LimitRange

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: LimitRange

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): LimitRange[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: LimitRange[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: LimitRange[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsLimitRange[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: LimitRange): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: LimitRange[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsLimitRange[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    load(params: object): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹LimitRange

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | LimitRange[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | LimitRange[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    loadItem(params: object): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹LimitRange

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹LimitRange[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹LimitRange[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: LimitRange[], __namedParameters: object): LimitRange[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: LimitRange[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: LimitRange[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: LimitRange): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    removeItem(item: LimitRange, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:119

    +

    Parameters:

    +

    item: LimitRange

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: LimitRange): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: LimitRange[], sorting?: function[], order?: "asc" | "desc"): LimitRange[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsLimitRange[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: LimitRange[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: LimitRange): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: LimitRange[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsLimitRange[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: LimitRange): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    +

    Returns: void

    +
    +

    update#

    +

    update(item: LimitRange, data: Partial‹LimitRange›): Promise‹LimitRange

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemLimitRange
    dataPartial‹LimitRange
    +

    Returns: Promise‹LimitRange

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: LimitRange, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: LimitRange

    +

    request: function

    +

    ▸ (): Promise‹LimitRange

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html new file mode 100644 index 0000000000..2419f62383 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html @@ -0,0 +1,1589 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Namespace - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Namespace

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html new file mode 100644 index 0000000000..27b86c6cd5 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html @@ -0,0 +1,2534 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NamespaceStore#

    +

    Hierarchy#

    +

    KubeObjectStoreNamespace

    +

    NamespaceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NamespaceStore(): NamespaceStore

    +

    Overrides KubeObjectStore.constructor

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:36

    +

    Returns: NamespaceStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiNamespace‹›› = namespacesApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:34

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    allowedNamespaces#

    +

    get allowedNamespaces(): string[]

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:94

    +

    Returns: string[]

    +
    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Namespace[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Namespace[]

    +
    +

    contextNamespaces#

    +

    get contextNamespaces(): string[]

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:101

    +

    Returns: string[]

    +
    +

    hasAllContexts#

    +

    get hasAllContexts(): boolean

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:150

    +

    Returns: boolean

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Namespace›): Promise‹Namespace

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Namespace[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Namespace[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Namespace

    +
    +

    getByPath#

    +

    getByPath(path: string): Namespace

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Namespace

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Namespace[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Namespace[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Namespace[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNamespace[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi‹any›[]

    +

    Overrides KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:111

    +

    Returns: KubeApi‹any›[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    hasContext#

    +

    hasContext(namespaces: string | string[]): boolean

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:146

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacesstring | string[]
    +

    Returns: boolean

    +
    +

    isSelected#

    +

    isSelected(item: Namespace): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Namespace[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Namespace

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Namespace[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Namespace[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Namespace

    +
    +

    Protected loadItems#

    +

    loadItems(params: KubeObjectStoreLoadingParams): Promise‹Namespace‹›[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsKubeObjectStoreLoadingParams
    +

    Returns: Promise‹Namespace‹›[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Namespace[], __namedParameters: object): Namespace[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Namespace[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Namespace[]

    +
    +

    onContextChange#

    +

    onContextChange(callback: function, opts: IReactionOptions): IReactionDisposer

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:51

    +

    Parameters:

    +

    callback: function

    +

    ▸ (contextNamespaces: string[]): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    contextNamespacesstring[]
    +

    Default value opts: IReactionOptions= {}

    +

    Returns: IReactionDisposer

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Namespace): Promise‹void›

    +

    Overrides KubeObjectStore.remove

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:177

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    resetContext#

    +

    resetContext(): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:142

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Namespace): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: void

    +
    +

    setContext#

    +

    setContext(namespace: string | string[]): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:135

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacestring | string[]
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    sortItems(items: Namespace[], sorting?: function[], order?: "asc" | "desc"): Namespace[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNamespace[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Namespace[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleAll#

    +

    toggleAll(showAll?: boolean): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:164

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    showAll?boolean
    +

    Returns: void

    +
    +

    toggleContext#

    +

    toggleContext(namespace: string): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:155

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: void

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Namespace): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Namespace[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNamespace[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Namespace): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNamespace
    dataPartial‹Namespace
    +

    Returns: Promise‹Namespace

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Namespace, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Namespace

    +

    request: function

    +

    ▸ (): Promise‹Namespace

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html new file mode 100644 index 0000000000..3014acc1bc --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html @@ -0,0 +1,1631 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: NetworkPolicy

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    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:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html new file mode 100644 index 0000000000..f4847dcdf8 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicyStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NetworkPolicyStore#

    +

    Hierarchy#

    +

    KubeObjectStoreNetworkPolicy

    +

    NetworkPolicyStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NetworkPolicyStore(): NetworkPolicyStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: NetworkPolicyStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiNetworkPolicy‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: NetworkPolicy[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: NetworkPolicy[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: NetworkPolicy

    +
    +

    getByPath#

    +

    getByPath(path: string): NetworkPolicy

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: NetworkPolicy

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: NetworkPolicy[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: NetworkPolicy[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNetworkPolicy[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: NetworkPolicy): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: NetworkPolicy[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹NetworkPolicy

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | NetworkPolicy[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | NetworkPolicy[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹NetworkPolicy

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹NetworkPolicy[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹NetworkPolicy[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: NetworkPolicy[], __namedParameters: object): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: NetworkPolicy[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: NetworkPolicy[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: NetworkPolicy): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNetworkPolicy[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: NetworkPolicy[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: NetworkPolicy[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNetworkPolicy[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    dataPartial‹NetworkPolicy
    +

    Returns: Promise‹NetworkPolicy

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: NetworkPolicy, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: NetworkPolicy

    +

    request: function

    +

    ▸ (): Promise‹NetworkPolicy

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.node/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.node/index.html new file mode 100644 index 0000000000..6c1c174bec --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.node/index.html @@ -0,0 +1,1811 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Node - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Node

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    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:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    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:143

    +

    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:116

    +

    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:120

    +

    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:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    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:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html new file mode 100644 index 0000000000..ac638a6be0 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html @@ -0,0 +1,1746 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NodesApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Node
    +

    Returns: NodesApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹Node

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹Node

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹Node›): Promise‹Node

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:329

    +

    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:356

    +

    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:321

    +

    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:242

    +

    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:250

    +

    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:363

    +

    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:313

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Node[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:446

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    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:274

    +

    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:246

    +

    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:238

    +

    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:347

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Node

    +

    Returns: Promise‹Node

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:371

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html new file mode 100644 index 0000000000..b193ba0f95 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html @@ -0,0 +1,2504 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NodesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NodesStore#

    +

    Hierarchy#

    +

    KubeObjectStoreNode

    +

    NodesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NodesStore(): NodesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: NodesStore

    +

    Properties#

    +

    api#

    +

    api: NodesApi‹› = nodesApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:10

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    metrics#

    +

    metrics: Partial‹INodeMetrics›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:12

    +
    +

    metricsLoaded#

    +

    metricsLoaded: boolean = false

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:15

    +
    +

    metricsLoading#

    +

    metricsLoading: boolean = false

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:14

    +
    +

    nodeMetrics#

    +

    nodeMetrics: Partial‹IClusterMetrics› = null

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:13

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Node[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Node[]

    +
    +

    masterNodes#

    +

    get masterNodes(): Node‹›[]

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:34

    +

    Returns: Node‹›[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:38

    +

    Returns: Node‹›[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Node›): Promise‹Node

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Node[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Node[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Node

    +
    +

    getByPath#

    +

    getByPath(path: string): Node

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Node

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Node[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Node[]

    +
    +

    getLastMetricValues#

    +

    getLastMetricValues(node: Node, metricNames: string[]): number[]

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:42

    +

    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:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNode[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    getWarningsCount#

    +

    getWarningsCount(): number

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:66

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Node): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Node[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Node

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Node[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Node[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Node

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Node[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Node[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(nodeName: string): Promise‹void›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:30

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    nodeNamestring
    +

    Returns: Promise‹void›

    +
    +

    loadUsageMetrics#

    +

    loadUsageMetrics(): Promise‹void›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:18

    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Node[], __namedParameters: object): Node[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Node[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Node[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Node): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:70

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Node): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNode[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Node[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Node): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Node[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNode[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Node): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNode
    dataPartial‹Node
    +

    Returns: Promise‹Node

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Node, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Node

    +

    request: function

    +

    ▸ (): Promise‹Node

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html new file mode 100644 index 0000000000..48d28ac7f0 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html @@ -0,0 +1,1723 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolume - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PersistentVolume

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    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:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html new file mode 100644 index 0000000000..ad2e92ebf5 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html @@ -0,0 +1,1698 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumeClaim - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PersistentVolumeClaim

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    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:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    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:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html new file mode 100644 index 0000000000..fa593d668c --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html @@ -0,0 +1,1765 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumeClaimsApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹PersistentVolumeClaim
    +

    Returns: PersistentVolumeClaimsApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹PersistentVolumeClaim

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹PersistentVolumeClaim

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:329

    +

    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:356

    +

    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:321

    +

    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:242

    +

    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:250

    +

    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:363

    +

    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:313

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹PersistentVolumeClaim[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:446

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    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:274

    +

    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:246

    +

    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:238

    +

    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:347

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹PersistentVolumeClaim

    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:371

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html new file mode 100644 index 0000000000..77f8147d19 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PersistentVolumesStore#

    +

    Hierarchy#

    +

    KubeObjectStorePersistentVolume

    +

    PersistentVolumesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolumesStore(): PersistentVolumesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: PersistentVolumesStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiPersistentVolume‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): PersistentVolume[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: PersistentVolume[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PersistentVolume[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): PersistentVolume[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PersistentVolume

    +
    +

    getByPath#

    +

    getByPath(path: string): PersistentVolume

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PersistentVolume

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): PersistentVolume[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: PersistentVolume[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: PersistentVolume[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolume[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: PersistentVolume): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: PersistentVolume[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolume

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | PersistentVolume[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | PersistentVolume[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolume

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹PersistentVolume[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹PersistentVolume[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: PersistentVolume[], __namedParameters: object): PersistentVolume[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: PersistentVolume[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: PersistentVolume[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: PersistentVolume): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPersistentVolume[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PersistentVolume[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: PersistentVolume[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolume[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    dataPartial‹PersistentVolume
    +

    Returns: Promise‹PersistentVolume

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: PersistentVolume, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: PersistentVolume

    +

    request: function

    +

    ▸ (): Promise‹PersistentVolume

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html new file mode 100644 index 0000000000..5c083dc7bb --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html @@ -0,0 +1,2149 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Pod - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Pod

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:190

    +

    Type declaration:

    +
      +
    • +

      activeDeadlineSeconds? : number

      +
    • +
    • +

      affinity? : IAffinity

      +
    • +
    • +

      automountServiceAccountToken? : boolean

      +
    • +
    • +

      containers: IPodContainer[]

      +
    • +
    • +

      dnsPolicy? : string

      +
    • +
    • +

      hostAliases(): object

      +
    • +
    • +

      hostnames: string[]

      +
    • +
    • +

      ip: string

      +
    • +
    • +

      hostIPC? : boolean

      +
    • +
    • +

      hostNetwork? : boolean

      +
    • +
    • +

      hostPID? : boolean

      +
    • +
    • +

      hostname? : string

      +
    • +
    • +

      imagePullSecrets? : object[]

      +
    • +
    • +

      initContainers: IPodContainer[]

      +
    • +
    • +

      nodeName? : string

      +
    • +
    • +

      nodeSelector(): object

      +
    • +
    • +

      priority? : number

      +
    • +
    • +

      priorityClassName? : string

      +
    • +
    • +

      restartPolicy? : string

      +
    • +
    • +

      schedulerName? : string

      +
    • +
    • +

      securityContext(): object

      +
    • +
    • +

      serviceAccount: string

      +
    • +
    • +

      serviceAccountName: string

      +
    • +
    • +

      shareProcessNamespace? : boolean

      +
    • +
    • +

      subdomain? : string

      +
    • +
    • +

      terminationGracePeriodSeconds? : number

      +
    • +
    • +

      tolerations? : object[]

      +
    • +
    • +

      volumes? : object[]

      +
    • +
    +
    +

    Optional status#

    +

    status? : object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:247

    +

    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:188

    +
    +

    Static kind#

    +

    kind: string = "Pod"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:186

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:187

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    getAffinity(): IAffinity

    +

    Overrides Deployment.getAffinity

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:407

    +

    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:126

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAllContainers#

    +

    getAllContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:272

    +

    Returns: IPodContainer[]

    +
    +

    getAnnotations#

    +

    getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:381

    +

    Returns: object[]

    +
    +

    getContainerStatuses#

    +

    getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:285

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    includeInitContainersbooleantrue
    +

    Returns: IPodContainerStatus[]

    +
    +

    getContainers#

    +

    getContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:268

    +

    Returns: IPodContainer[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getInitContainers#

    +

    getInitContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:264

    +

    Returns: IPodContainer[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getLivenessProbe#

    +

    getLivenessProbe(container: IPodContainer): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:428

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    containerIPodContainer
    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNodeName#

    +

    getNodeName(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:478

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    getNodeSelectors(): string[]

    +

    Overrides Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:395

    +

    Returns: string[]

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getPriorityClassName#

    +

    getPriorityClassName(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:316

    +

    Returns: string

    +
    +

    getProbe#

    +

    getProbe(probeData: IContainerProbe): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:440

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    probeDataIContainerProbe
    +

    Returns: string[]

    +
    +

    getQosClass#

    +

    getQosClass(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:308

    +

    Returns: string

    +
    +

    getReadinessProbe#

    +

    getReadinessProbe(container: IPodContainer): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:432

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    containerIPodContainer
    +

    Returns: string[]

    +
    +

    getReason#

    +

    getReason(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:312

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getRestartsCount#

    +

    getRestartsCount(): number

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:300

    +

    Returns: number

    +
    +

    getRunningContainers#

    +

    getRunningContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:276

    +

    Returns: IPodContainer[]

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    Returns: string[]

    +
    +

    getSecrets#

    +

    getSecrets(): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:389

    +

    Returns: string[]

    +
    +

    getSelectedNodeOs#

    +

    getSelectedNodeOs(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:482

    +

    Returns: string

    +
    +

    getSelectors#

    +

    getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getStartupProbe#

    +

    getStartupProbe(container: IPodContainer): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:436

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    containerIPodContainer
    +

    Returns: string[]

    +
    +

    getStatus#

    +

    getStatus(): FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:321

    +

    Returns: FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

    +
    +

    getStatusMessage#

    +

    getStatusMessage(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:348

    +

    Returns: string

    +
    +

    getStatusPhase#

    +

    getStatusPhase(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:377

    +

    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:403

    +

    Returns: object[]

    +
    +

    getVolumes#

    +

    getVolumes(): object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:385

    +

    Returns: object[]

    +
    +

    hasIssues#

    +

    hasIssues(): boolean

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:411

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html new file mode 100644 index 0000000000..cac59db44c --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html @@ -0,0 +1,1679 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudget - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PodDisruptionBudget

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    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:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    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:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html new file mode 100644 index 0000000000..680808aabb --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudgetsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PodDisruptionBudgetsStore#

    +

    Hierarchy#

    +

    KubeObjectStorePodDisruptionBudget

    +

    PodDisruptionBudgetsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodDisruptionBudgetsStore(): PodDisruptionBudgetsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: PodDisruptionBudgetsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiPodDisruptionBudget‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: PodDisruptionBudget[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PodDisruptionBudget[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PodDisruptionBudget

    +
    +

    getByPath#

    +

    getByPath(path: string): PodDisruptionBudget

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PodDisruptionBudget

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: PodDisruptionBudget[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: PodDisruptionBudget[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPodDisruptionBudget[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: PodDisruptionBudget): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: PodDisruptionBudget[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PodDisruptionBudget

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | PodDisruptionBudget[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | PodDisruptionBudget[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PodDisruptionBudget

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹PodDisruptionBudget[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹PodDisruptionBudget[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: PodDisruptionBudget[], __namedParameters: object): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: PodDisruptionBudget[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: PodDisruptionBudget[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: PodDisruptionBudget): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPodDisruptionBudget[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PodDisruptionBudget[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: PodDisruptionBudget[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPodDisruptionBudget[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    dataPartial‹PodDisruptionBudget
    +

    Returns: Promise‹PodDisruptionBudget

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: PodDisruptionBudget, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: PodDisruptionBudget

    +

    request: function

    +

    ▸ (): Promise‹PodDisruptionBudget

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html new file mode 100644 index 0000000000..17946f4320 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html @@ -0,0 +1,1807 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodsApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:117

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Pod
    +

    Returns: PodsApi

    +

    Properties#

    +

    apiBase#

    +

    apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:106

    +
    +

    apiGroup#

    +

    apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:108

    +
    +

    apiPrefix#

    +

    apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:107

    +
    +

    apiResource#

    +

    apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:111

    +
    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:109

    +
    +

    Optional apiVersionPreferred#

    +

    apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:110

    +
    +

    isNamespaced#

    +

    isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:112

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:105

    +
    +

    objectConstructor#

    +

    objectConstructor: IKubeObjectConstructor‹Pod

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:114

    +
    +

    Protected options#

    +

    options: IKubeApiOptions‹Pod

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:119

    +
    +

    Protected request#

    +

    request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:115

    +
    +

    Protected resourceVersions#

    +

    resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:116

    +
    +

    Protected watchDisposer#

    +

    watchDisposer: function

    +

    Inherited from KubeApi.watchDisposer

    +

    Defined in src/renderer/api/kube-api.ts:117

    +

    Type declaration:

    +

    ▸ (): void

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:147

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:209

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    create(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:329

    +

    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:356

    +

    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:321

    +

    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:242

    +

    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:250

    +

    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:363

    +

    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:313

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Pod[]›

    +
    +

    Protected modifyWatchEvent#

    +

    modifyWatchEvent(event: IKubeWatchEvent): void

    +

    Inherited from KubeApi.modifyWatchEvent

    +

    Defined in src/renderer/api/kube-api.ts:446

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventIKubeWatchEvent
    +

    Returns: void

    +
    +

    Protected normalizeQuery#

    +

    normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:262

    +

    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:274

    +

    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:246

    +

    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:238

    +

    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:347

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Optional data: Partial‹Pod

    +

    Returns: Promise‹Pod

    +
    +

    watch#

    +

    watch(opts: KubeApiWatchOptions): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:371

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    optsKubeApiWatchOptions{ namespace: "" }
    +

    Returns: function

    +

    ▸ (): void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html new file mode 100644 index 0000000000..c55b84cf25 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html @@ -0,0 +1,2572 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PodsStore#

    +

    Hierarchy#

    +

    KubeObjectStorePod

    +

    PodsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodsStore(): PodsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    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

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Pod[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Pod[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Pod›): Promise‹Pod

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Pod[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Pod[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Pod

    +
    +

    getByPath#

    +

    getByPath(path: string): Pod

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Pod

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Pod[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Pod[]

    +
    +

    getPodKubeMetrics#

    +

    getPodKubeMetrics(pod: Pod): object

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:63

    +

    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:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    nodestring
    +

    Returns: Pod‹›[]

    +
    +

    getPodsByOwner#

    +

    getPodsByOwner(workload: WorkloadKubeObject): Pod[]

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    workloadWorkloadKubeObject
    +

    Returns: Pod[]

    +
    +

    getPodsByOwnerId#

    +

    getPodsByOwnerId(workloadId: string): Pod[]

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:47

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    workloadIdstring
    +

    Returns: Pod[]

    +
    +

    getStatuses#

    +

    getStatuses(pods: Pod[]): Dictionary‹number›

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:59

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podsPod[]
    +

    Returns: Dictionary‹number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Pod): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Pod[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Pod

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Pod[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Pod[]›

    +
    +

    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:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Pod

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Pod[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    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 mergeItems#

    +

    mergeItems(partialItems: Pod[], __namedParameters: object): Pod[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Pod[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Pod[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Pod): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:92

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Pod): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPod[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Pod[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Pod): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Pod[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPod[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Pod): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPod
    dataPartial‹Pod
    +

    Returns: Promise‹Pod

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Pod, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Pod

    +

    request: function

    +

    ▸ (): Promise‹Pod

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html new file mode 100644 index 0000000000..55b1b8de2f --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html @@ -0,0 +1,1774 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    + +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ReplicaSet

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    spec#

    +

    spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:35

    +

    Type declaration:

    +
      +
    • +

      minReadySeconds? : number

      +
    • +
    • +

      replicas? : number

      +
    • +
    • +

      selector(): object

      +
    • +
    • +

      matchLabels(): object

      +
    • +
    • +

      template(): object

      +
    • +
    • +

      metadata(): object

      +
        +
      • +

        labels(): object

        +
      • +
      • +

        app: string

        +
      • +
      +
    • +
    • +

      spec? : Pod["spec"]

      +
    • +
    +
    +

    status#

    +

    status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:48

    +

    Type declaration:

    +
      +
    • +

      availableReplicas? : number

      +
    • +
    • +

      conditions? : object[]

      +
    • +
    • +

      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:34

    +
    +

    Static kind#

    +

    kind: string = "ReplicaSet"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:32

    +
    +

    Static namespaced#

    +

    namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:33

    +

    Accessors#

    + +

    get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getCurrent#

    +

    getCurrent(): number

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:68

    +

    Returns: number

    +
    +

    getDesired#

    +

    getDesired(): number

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:64

    +

    Returns: number

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getImages#

    +

    getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:76

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    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:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getReady#

    +

    getReady(): number

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:72

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html new file mode 100644 index 0000000000..d87f8fc765 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html @@ -0,0 +1,2451 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ReplicaSetStore#

    +

    Hierarchy#

    +

    KubeObjectStoreReplicaSet

    +

    ReplicaSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ReplicaSetStore(): ReplicaSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ReplicaSetStore

    +

    Properties#

    +

    api#

    +

    api: ReplicaSetApi‹› = replicaSetApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11

    +
    +

    bufferSize#

    +

    bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    metrics#

    +

    metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:12

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): ReplicaSet[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: ReplicaSet[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ReplicaSet[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): ReplicaSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ReplicaSet

    +
    +

    getByPath#

    +

    getByPath(path: string): ReplicaSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ReplicaSet

    +
    +

    getChildPods#

    +

    getChildPods(replicaSet: ReplicaSet): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:20

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    replicaSetReplicaSet
    +

    Returns: Pod‹›[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ReplicaSet[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ReplicaSet[]

    +
    +

    getReplicaSetsByOwner#

    +

    getReplicaSetsByOwner(deployment: Deployment): ReplicaSet‹›[]

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:44

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deploymentDeployment
    +

    Returns: ReplicaSet‹›[]

    +
    +

    getStatuses#

    +

    getStatuses(replicaSets: ReplicaSet[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:24

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    replicaSetsReplicaSet[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
    • +
    • +

      pending: number = 0

      +
    • +
    • +

      running: number = 0

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: ReplicaSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: ReplicaSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ReplicaSet

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | ReplicaSet[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ReplicaSet[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ReplicaSet

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹ReplicaSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹ReplicaSet[]›

    +
    +

    loadMetrics#

    +

    loadMetrics(replicaSet: ReplicaSet): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    replicaSetReplicaSet
    +

    Returns: Promise‹void›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ReplicaSet[], __namedParameters: object): ReplicaSet[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: ReplicaSet[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ReplicaSet[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: ReplicaSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:50

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsReplicaSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ReplicaSet[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: ReplicaSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsReplicaSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    dataPartial‹ReplicaSet
    +

    Returns: Promise‹ReplicaSet

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: ReplicaSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: ReplicaSet

    +

    request: function

    +

    ▸ (): Promise‹ReplicaSet

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html new file mode 100644 index 0000000000..7ec42858d0 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html @@ -0,0 +1,1618 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuota - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    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:166

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html new file mode 100644 index 0000000000..a82bfa9def --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuotasStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ResourceQuotasStore#

    +

    Hierarchy#

    +

    KubeObjectStoreResourceQuota

    +

    ResourceQuotasStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ResourceQuotasStore(): ResourceQuotasStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ResourceQuotasStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiResourceQuota‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): ResourceQuota[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: ResourceQuota[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ResourceQuota[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): ResourceQuota[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ResourceQuota

    +
    +

    getByPath#

    +

    getByPath(path: string): ResourceQuota

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ResourceQuota

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ResourceQuota[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ResourceQuota[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: ResourceQuota[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsResourceQuota[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: ResourceQuota): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: ResourceQuota[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ResourceQuota

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | ResourceQuota[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ResourceQuota[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ResourceQuota

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹ResourceQuota[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹ResourceQuota[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ResourceQuota[], __namedParameters: object): ResourceQuota[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: ResourceQuota[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ResourceQuota[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: ResourceQuota): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsResourceQuota[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ResourceQuota[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: ResourceQuota[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsResourceQuota[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    dataPartial‹ResourceQuota
    +

    Returns: Promise‹ResourceQuota

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: ResourceQuota, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: ResourceQuota

    +

    request: function

    +

    ▸ (): Promise‹ResourceQuota

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.role/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.role/index.html new file mode 100644 index 0000000000..1491fb541b --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.role/index.html @@ -0,0 +1,1598 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Role - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Role

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    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:166

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html new file mode 100644 index 0000000000..6f0eabf09e --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html @@ -0,0 +1,1635 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RoleBinding - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: RoleBinding

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html new file mode 100644 index 0000000000..c109f2edf6 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html @@ -0,0 +1,2361 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RoleBindingsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RoleBindingsStore#

    +

    Hierarchy#

    +

    KubeObjectStoreRoleBinding

    +

    RoleBindingsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RoleBindingsStore(): RoleBindingsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: RoleBindingsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiClusterRoleBinding‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): RoleBinding[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: RoleBinding[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:38

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: RoleBinding[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): RoleBinding[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: RoleBinding

    +
    +

    getByPath#

    +

    getByPath(path: string): RoleBinding

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: RoleBinding

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): RoleBinding[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: RoleBinding[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: RoleBinding[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRoleBinding[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApiRoleBinding‹››[]

    +

    Overrides KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

    +

    Returns: KubeApiRoleBinding‹››[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: RoleBinding): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: RoleBinding[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹RoleBinding

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | RoleBinding[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | RoleBinding[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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(params: KubeObjectStoreLoadingParams): Promise‹RoleBinding[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsKubeObjectStoreLoadingParams
    +

    Returns: Promise‹RoleBinding[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: RoleBinding[], __namedParameters: object): RoleBinding[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: RoleBinding[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: RoleBinding[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: RoleBinding): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: RoleBinding[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRoleBinding[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    dataPartial‹RoleBinding
    +

    Returns: Promise‹RoleBinding

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: RoleBinding, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    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:46

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    addSubjects?IRoleBindingSubject[]
    removeSubjects?IRoleBindingSubject[]
    roleBindingRoleBinding
    +

    Returns: Promise‹RoleBinding‹››

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html new file mode 100644 index 0000000000..f35ce9a6c9 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html @@ -0,0 +1,2324 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RolesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RolesStore#

    +

    Hierarchy#

    +

    KubeObjectStoreRole

    +

    RolesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RolesStore(): RolesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: RolesStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiClusterRole‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Role[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Role[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Role›): Promise‹Role

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:36

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Role[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Role[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Role

    +
    +

    getByPath#

    +

    getByPath(path: string): Role

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Role

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Role[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Role[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Role[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRole[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApiRole‹››[]

    +

    Overrides KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

    +

    Returns: KubeApiRole‹››[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Role): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Role[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Role

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Role[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Role[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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(params: KubeObjectStoreLoadingParams): Promise‹Role[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsKubeObjectStoreLoadingParams
    +

    Returns: Promise‹Role[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Role[], __namedParameters: object): Role[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Role[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Role[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Role): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Role): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Role): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Role[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRole[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Role): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemRole
    dataPartial‹Role
    +

    Returns: Promise‹Role

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Role, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Role

    +

    request: function

    +

    ▸ (): Promise‹Role

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html new file mode 100644 index 0000000000..4430a97a25 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html @@ -0,0 +1,1631 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Secret - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:99

    +
    +

    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:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    Optional status#

    +

    status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    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:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html new file mode 100644 index 0000000000..bec97435ee --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: SecretsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: SecretsStore#

    +

    Hierarchy#

    +

    KubeObjectStoreSecret

    +

    SecretsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new SecretsStore(): SecretsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: SecretsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiSecret‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Secret[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Secret[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Secret›): Promise‹Secret

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Secret[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Secret[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Secret

    +
    +

    getByPath#

    +

    getByPath(path: string): Secret

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Secret

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Secret[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Secret[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Secret[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsSecret[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Secret): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Secret[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Secret

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Secret[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Secret[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Secret

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Secret[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Secret[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Secret[], __namedParameters: object): Secret[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Secret[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Secret[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Secret): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Secret): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsSecret[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Secret[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Secret): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Secret[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsSecret[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Secret): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemSecret
    dataPartial‹Secret
    +

    Returns: Promise‹Secret

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Secret, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Secret

    +

    request: function

    +

    ▸ (): Promise‹Secret

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.service/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.service/index.html new file mode 100644 index 0000000000..2919e293b1 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.service/index.html @@ -0,0 +1,1727 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Service - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Service

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    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:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    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:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    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:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html new file mode 100644 index 0000000000..28eb3b235b --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html @@ -0,0 +1,1622 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccount - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    + +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ServiceAccount

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    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:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    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:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html new file mode 100644 index 0000000000..5beeacd7e0 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html @@ -0,0 +1,2342 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccountsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ServiceAccountsStore#

    +

    Hierarchy#

    +

    KubeObjectStoreServiceAccount

    +

    ServiceAccountsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ServiceAccountsStore(): ServiceAccountsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ServiceAccountsStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiServiceAccount‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): ServiceAccount[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: ServiceAccount[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹ServiceAccount›): Promise‹ServiceAccount

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ServiceAccount[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): ServiceAccount[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ServiceAccount

    +
    +

    getByPath#

    +

    getByPath(path: string): ServiceAccount

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ServiceAccount

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): ServiceAccount[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: ServiceAccount[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: ServiceAccount[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsServiceAccount[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: ServiceAccount): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: ServiceAccount[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ServiceAccount

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | ServiceAccount[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | ServiceAccount[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ServiceAccount

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹ServiceAccount[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹ServiceAccount[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: ServiceAccount[], __namedParameters: object): ServiceAccount[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: ServiceAccount[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: ServiceAccount[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: ServiceAccount): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsServiceAccount[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ServiceAccount[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: ServiceAccount[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsServiceAccount[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    dataPartial‹ServiceAccount
    +

    Returns: Promise‹ServiceAccount

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: ServiceAccount, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: ServiceAccount

    +

    request: function

    +

    ▸ (): Promise‹ServiceAccount

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html new file mode 100644 index 0000000000..36d0014454 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ServiceStore#

    +

    Hierarchy#

    +

    KubeObjectStoreService

    +

    ServiceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ServiceStore(): ServiceStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: ServiceStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiService‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): Service[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: Service[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹Service›): Promise‹Service

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Service[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): Service[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Service

    +
    +

    getByPath#

    +

    getByPath(path: string): Service

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Service

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): Service[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: Service[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: Service[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsService[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: Service): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: Service[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Service

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | Service[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | Service[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Service

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹Service[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹Service[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: Service[], __namedParameters: object): Service[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: Service[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: Service[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: Service): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: Service): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsService[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Service[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: Service): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: Service[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsService[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: Service): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemService
    dataPartial‹Service
    +

    Returns: Promise‹Service

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: Service, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: Service

    +

    request: function

    +

    ▸ (): Promise‹Service

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html new file mode 100644 index 0000000000..767e55a3df --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html @@ -0,0 +1,1768 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    + +
    +
    + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: StatefulSet

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    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:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    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:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    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:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html new file mode 100644 index 0000000000..04cf0c4759 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html @@ -0,0 +1,2423 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StatefulSetStore#

    +

    Hierarchy#

    +

    KubeObjectStoreStatefulSet

    +

    StatefulSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StatefulSetStore(): StatefulSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    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

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): StatefulSet[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: StatefulSet[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: StatefulSet[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): StatefulSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: StatefulSet

    +
    +

    getByPath#

    +

    getByPath(path: string): StatefulSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    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‹›[]

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): StatefulSet[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: StatefulSet[]

    +
    +

    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

      +
    • +
    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: StatefulSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: StatefulSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StatefulSet

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | StatefulSet[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | StatefulSet[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StatefulSet

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹StatefulSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    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 mergeItems#

    +

    mergeItems(partialItems: StatefulSet[], __namedParameters: object): StatefulSet[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: StatefulSet[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: StatefulSet[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: StatefulSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsStatefulSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: StatefulSet[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: StatefulSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStatefulSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    dataPartial‹StatefulSet
    +

    Returns: Promise‹StatefulSet

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: StatefulSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: StatefulSet

    +

    request: function

    +

    ▸ (): Promise‹StatefulSet

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html new file mode 100644 index 0000000000..bce25e749e --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html @@ -0,0 +1,1675 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StorageClass - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:93

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: StorageClass

    +

    Properties#

    +

    apiVersion#

    +

    apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:99

    +
    +

    kind#

    +

    kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:100

    +
    +

    metadata#

    +

    metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:101

    +
    +

    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:102

    +
    +

    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:104

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:190

    +

    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:126

    +

    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:147

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:139

    +

    Returns: string[]

    +
    +

    getId#

    +

    getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:108

    +

    Returns: string

    +
    +

    getLabels#

    +

    getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getName#

    +

    getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string

    +
    +

    getNs#

    +

    getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:157

    +

    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:112

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:166

    +

    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:178

    +

    Returns: object

    +
    +

    update#

    +

    updateT›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:183

    +

    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:73

    +

    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:81

    +

    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:85

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html new file mode 100644 index 0000000000..2f65915462 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html @@ -0,0 +1,2344 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StorageClassStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StorageClassStore#

    +

    Hierarchy#

    +

    KubeObjectStoreStorageClass

    +

    StorageClassStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StorageClassStore(): StorageClassStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    Returns: StorageClassStore

    +

    Properties#

    +

    api#

    +

    api: KubeApiStorageClass‹›› = 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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    selectedItemsIds#

    +

    selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): StorageClass[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: StorageClass[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: StorageClass[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): StorageClass[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: StorageClass

    +
    +

    getByPath#

    +

    getByPath(path: string): StorageClass

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: StorageClass

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): StorageClass[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: StorageClass[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: StorageClass[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsStorageClass[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: StorageClass): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: StorageClass[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StorageClass

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | StorageClass[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | StorageClass[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StorageClass

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹StorageClass[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    Returns: Promise‹StorageClass[]›

    +
    +

    Protected mergeItems#

    +

    mergeItems(partialItems: StorageClass[], __namedParameters: object): StorageClass[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: StorageClass[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: StorageClass[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: StorageClass): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:171

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: StorageClass): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsStorageClass[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: StorageClass[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: StorageClass): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: StorageClass[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStorageClass[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: StorageClass): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    dataPartial‹StorageClass
    +

    Returns: Promise‹StorageClass

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: StorageClass, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: StorageClass

    +

    request: function

    +

    ▸ (): Promise‹StorageClass

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html new file mode 100644 index 0000000000..92599217b8 --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html @@ -0,0 +1,2384 @@ + + + + + + + + + + + + + + + + + + + + + + Class: VolumeClaimStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: VolumeClaimStore#

    +

    Hierarchy#

    +

    KubeObjectStorePersistentVolumeClaim

    +

    VolumeClaimStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new VolumeClaimStore(): VolumeClaimStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:26

    +

    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:23

    +
    +

    contextReady#

    +

    contextReady: Promise‹void› & object = when(() => Boolean(this.context))

    +

    Inherited from KubeObjectStore.contextReady

    +

    Defined in src/renderer/kube-object.store.ts:26

    +
    +

    Protected eventsBuffer#

    +

    eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable.array>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:259

    +
    +

    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:22

    +
    +

    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

    +
    +

    Static defaultContext#

    +

    defaultContext: ClusterContext

    +

    Inherited from KubeObjectStore.defaultContext

    +

    Defined in src/renderer/kube-object.store.ts:19

    +

    Accessors#

    +

    context#

    +

    get context(): ClusterContext

    +

    Inherited from KubeObjectStore.context

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Returns: ClusterContext

    +
    +

    contextItems#

    +

    get contextItems(): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.contextItems

    +

    Defined in src/renderer/kube-object.store.ts:37

    +

    Returns: PersistentVolumeClaim[]

    +
    +

    query#

    +

    get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:51

    +

    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:186

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    bindWatchEventsUpdater(delay: number): void

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:261

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: void

    +
    +

    create#

    +

    create(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:230

    +

    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:226

    +

    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:130

    +

    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:63

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    getById#

    +

    getById(id: string): T

    +

    Inherited from KubeObjectStore.getById

    +

    Defined in src/renderer/kube-object.store.ts:73

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: T

    +
    +

    getByLabel#

    +

    getByLabel(labels: string[] | object): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    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:77

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PersistentVolumeClaim

    +
    +

    getByPath#

    +

    getByPath(path: string): PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PersistentVolumeClaim

    +
    +

    getIndexById#

    +

    getIndexById(id: string): number

    +

    Inherited from KubeObjectStore.getIndexById

    +

    Defined in src/renderer/item.store.ts:38

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: number

    +
    +

    getItems#

    +

    getItems(): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.getItems

    +

    Defined in src/renderer/item.store.ts:25

    +

    Returns: PersistentVolumeClaim[]

    +
    +

    Optional getStatuses#

    +

    getStatuses(items: PersistentVolumeClaim[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:61

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolumeClaim[]
    +

    Returns: Record‹string, number›

    +
    +

    getSubscribeApis#

    +

    getSubscribeApis(): KubeApi[]

    +

    Inherited from KubeObjectStore.getSubscribeApis

    +

    Defined in src/renderer/kube-object.store.ts:267

    +

    Returns: KubeApi[]

    +
    +

    getTotalCount#

    +

    getTotalCount(): number

    +

    Inherited from KubeObjectStore.getTotalCount

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:47

    +

    Returns: number

    +
    +

    isSelected#

    +

    isSelected(item: PersistentVolumeClaim): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    isSelectedAll(visibleItems: PersistentVolumeClaim[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:159

    +

    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:205

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    loadAll#

    +

    loadAll(options: object): Promise‹void | PersistentVolumeClaim[]›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:135

    +

    Parameters:

    +

    Default value options: object= {}

    + + + + + + + + + + + + + + + + + +
    NameType
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | PersistentVolumeClaim[]›

    +
    +

    loadFromPath#

    +

    loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:220

    +

    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:200

    +

    Parameters:

    +

    params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    Protected loadItems#

    +

    loadItems(__namedParameters: object): Promise‹PersistentVolumeClaim[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:106

    +

    Parameters:

    +

    __namedParameters: object

    + + + + + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹any›
    namespacesstring[]
    +

    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 mergeItems#

    +

    mergeItems(partialItems: PersistentVolumeClaim[], __namedParameters: object): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.mergeItems

    +

    Defined in src/renderer/kube-object.store.ts:176

    +

    Parameters:

    +

    partialItems: PersistentVolumeClaim[]

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleantrue
    replacebooleanfalse
    sortbooleantrue
    updateStorebooleantrue
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    reloadAll#

    +

    reloadAll(opts: object): Promise‹void | T[]›

    +

    Inherited from KubeObjectStore.reloadAll

    +

    Defined in src/renderer/kube-object.store.ts:165

    +

    Parameters:

    +

    Default value opts: object= {}

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    force?boolean
    merge?boolean
    namespaces?string[]
    +

    Returns: Promise‹void | T[]›

    +
    +

    remove#

    +

    remove(item: PersistentVolumeClaim): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:248

    +

    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:119

    +

    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:254

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

    +

    Returns: void

    +
    +

    Protected resetOnError#

    +

    resetOnError(error: any): void

    +

    Inherited from KubeObjectStore.resetOnError

    +

    Defined in src/renderer/kube-object.store.ts:196

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorany
    +

    Returns: void

    +
    +

    resetSelection#

    +

    resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:166

    +

    Returns: void

    +
    +

    select#

    +

    select(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:130

    +

    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:43

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPersistentVolumeClaim[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    subscribe#

    +

    subscribe(apis: KubeApi‹any›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:271

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹any›[]this.getSubscribeApis()
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    toggleSelection(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    toggleSelectionAll(visibleItems: PersistentVolumeClaim[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:149

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolumeClaim[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    unselect(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:135

    +

    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:239

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    dataPartial‹PersistentVolumeClaim
    +

    Returns: Promise‹PersistentVolumeClaim

    +
    +

    Protected updateFromEventsBuffer#

    +

    updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:349

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    updateItem(item: PersistentVolumeClaim, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    item: PersistentVolumeClaim

    +

    request: function

    +

    ▸ (): Promise‹PersistentVolumeClaim

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html b/v4.1.0/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html new file mode 100644 index 0000000000..2a84ff0dcb --- /dev/null +++ b/v4.1.0/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html @@ -0,0 +1,1376 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PageParam ‹**V**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PageParam ‹V#

    +

    Type parameters#

    +

    V

    +

    Hierarchy#

    +
      +
    • PageParam
    • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PageParam(init: PageParamInit‹V› | PageSystemParamInit‹V›, history: IObservableHistory): PageParam

    +

    Defined in src/renderer/navigation/page-param.ts:23

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    initPageParamInit‹V› | PageSystemParamInit‹V›
    historyIObservableHistory
    +

    Returns: PageParam

    +

    Properties#

    +

    Protected history#

    +

    history: IObservableHistory

    +

    Defined in src/renderer/navigation/page-param.ts:25

    +
    +

    init#

    +

    init: PageParamInit‹V› | PageSystemParamInit‹V›

    +

    Defined in src/renderer/navigation/page-param.ts:25

    +
    +

    name#

    +

    name: string

    +

    Defined in src/renderer/navigation/page-param.ts:22

    +
    +

    Protected urlName#

    +

    urlName: string

    +

    Defined in src/renderer/navigation/page-param.ts:23

    +
    +

    Static SYSTEM_PREFIX#

    +

    SYSTEM_PREFIX: string = "lens-"

    +

    Defined in src/renderer/navigation/page-param.ts:20

    +

    Methods#

    +

    clear#

    +

    clear(): void

    +

    Defined in src/renderer/navigation/page-param.ts:107

    +

    Returns: void

    +
    +

    get#

    +

    get(): V

    +

    Defined in src/renderer/navigation/page-param.ts:66

    +

    Returns: V

    +
    +

    getDefaultValue#

    +

    getDefaultValue(): V

    +

    Defined in src/renderer/navigation/page-param.ts:101

    +

    Returns: V

    +
    +

    getRaw#

    +

    getRaw(): string[]

    +

    Defined in src/renderer/navigation/page-param.ts:94

    +

    Returns: string[]

    +
    +

    isEmpty#

    +

    isEmpty(value: V | any): boolean

    +

    Defined in src/renderer/navigation/page-param.ts:36

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valueV | any
    +

    Returns: boolean

    +
    +

    parse#

    +

    parse(values: string[]): V

    +

    Defined in src/renderer/navigation/page-param.ts:40

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuesstring[]
    +

    Returns: V

    +
    +

    set#

    +

    set(value: V, __namedParameters: object): void

    +

    Defined in src/renderer/navigation/page-param.ts:76

    +

    Parameters:

    +

    value: V

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    mergeGlobalsbooleantrue
    replaceHistorybooleanfalse
    +

    Returns: void

    +
    +

    setRaw#

    +

    setRaw(value: string | string[]): void

    +

    Defined in src/renderer/navigation/page-param.ts:82

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuestring | string[]
    +

    Returns: void

    +
    +

    stringify#

    +

    stringify(value: V): string

    +

    Defined in src/renderer/navigation/page-param.ts:49

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    valueVthis.get()
    +

    Returns: string

    +
    +

    toObjectParam#

    +

    toObjectParam(value: V): Record‹string, V›

    +

    Defined in src/renderer/navigation/page-param.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    valueVthis.get()
    +

    Returns: Record‹string, V›

    +
    +

    toSearchString#

    +

    toSearchString(__namedParameters: object): string

    +

    Defined in src/renderer/navigation/page-param.ts:111

    +

    Parameters:

    +

    Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    mergeGlobalsbooleantrue
    valueVthis.get()
    withPrefixbooleantrue
    +

    Returns: string

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/classes/lensmainextension/index.html b/v4.1.0/extensions/api/classes/lensmainextension/index.html new file mode 100644 index 0000000000..1b0c652f1f --- /dev/null +++ b/v4.1.0/extensions/api/classes/lensmainextension/index.html @@ -0,0 +1,1331 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LensMainExtension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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›

    +
    + +

    navigateP›(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.1.0/extensions/api/classes/lensrendererextension/index.html b/v4.1.0/extensions/api/classes/lensrendererextension/index.html new file mode 100644 index 0000000000..9be8c08398 --- /dev/null +++ b/v4.1.0/extensions/api/classes/lensrendererextension/index.html @@ -0,0 +1,1476 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LensRendererExtension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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: ClusterPageMenuRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:11

    +
    +

    clusterPages#

    +

    clusterPages: PageRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:9

    +
    +

    commands#

    +

    commands: CommandRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:18

    +
    +

    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:35

    +

    Defines if extension is enabled for a given cluster. Defaults to true.

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    clusterCluster
    +

    Returns: Promise‹Boolean›

    +
    + +

    navigateP›(pageId?: string, params?: P): Promise‹void›

    +

    Defined in src/extensions/lens-renderer-extension.ts:20

    +

    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.1.0/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html b/v4.1.0/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html new file mode 100644 index 0000000000..9fa9593766 --- /dev/null +++ b/v4.1.0/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -0,0 +1,980 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: NotificationStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html b/v4.1.0/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html new file mode 100644 index 0000000000..c0340d0f85 --- /dev/null +++ b/v4.1.0/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -0,0 +1,1040 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: TooltipPosition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html b/v4.1.0/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html new file mode 100644 index 0000000000..5263da927a --- /dev/null +++ b/v4.1.0/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html @@ -0,0 +1,980 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: KubeObjectStatusLevel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/globals/index.html b/v4.1.0/extensions/api/globals/index.html new file mode 100644 index 0000000000..1d2ff6913f --- /dev/null +++ b/v4.1.0/extensions/api/globals/index.html @@ -0,0 +1,953 @@ + + + + + + + + + + + + + + + + + + + + + + @k8slens/extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + + +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/index.html b/v4.1.0/extensions/api/index.html new file mode 100644 index 0000000000..abf1898ced --- /dev/null +++ b/v4.1.0/extensions/api/index.html @@ -0,0 +1,947 @@ + + + + + + + + + + + + + + + + + + + + + + API Reference - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html b/v4.1.0/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html new file mode 100644 index 0000000000..5203ec55e4 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html @@ -0,0 +1,1007 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/v4.1.0/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html new file mode 100644 index 0000000000..e09d8133c7 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -0,0 +1,1083 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterModel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html b/v4.1.0/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html new file mode 100644 index 0000000000..aa2dd04ee6 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -0,0 +1,1026 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WorkspaceModel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html new file mode 100644 index 0000000000..3938fd2512 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html new file mode 100644 index 0000000000..deb2a836bf --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html new file mode 100644 index 0000000000..235068c927 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html new file mode 100644 index 0000000000..3e4d63d7fd --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -0,0 +1,991 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html new file mode 100644 index 0000000000..cc492f4caa --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html @@ -0,0 +1,1019 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterPageMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterPageMenuRegistration#

    +

    Hierarchy#

    + +

    ClusterPageMenuRegistration

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageMenuComponents

    +

    Inherited from PageMenuRegistration.components

    +

    Defined in src/extensions/registries/page-menu-registry.ts:12

    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/extensions/registries/page-menu-registry.ts:16

    +
    +

    Optional parentId#

    +

    parentId? : string

    +

    Defined in src/extensions/registries/page-menu-registry.ts:17

    +
    +

    Optional target#

    +

    target? : PageTarget

    +

    Inherited from PageMenuRegistration.target

    +

    Defined in src/extensions/registries/page-menu-registry.ts:10

    +
    +

    title#

    +

    title: React.ReactNode

    +

    Inherited from PageMenuRegistration.title

    +

    Defined in src/extensions/registries/page-menu-registry.ts:11

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html new file mode 100644 index 0000000000..3618cbe972 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html new file mode 100644 index 0000000000..bbaaf6ac56 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html new file mode 100644 index 0000000000..3a602016a1 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html new file mode 100644 index 0000000000..13b26457a2 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -0,0 +1,991 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html new file mode 100644 index 0000000000..570957e679 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -0,0 +1,1008 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectStatusRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html new file mode 100644 index 0000000000..52a258aa1d --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html @@ -0,0 +1,977 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponentProps ‹**P**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html new file mode 100644 index 0000000000..a9efc2cd2a --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html new file mode 100644 index 0000000000..8ea41d5f46 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageMenuComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html new file mode 100644 index 0000000000..98eae589c3 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -0,0 +1,992 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageMenuRegistration#

    +

    Hierarchy#

    +
      +
    • PageMenuRegistration
    • +
    +

    ClusterPageMenuRegistration

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageMenuComponents

    +

    Defined in src/extensions/registries/page-menu-registry.ts:12

    +
    +

    Optional target#

    +

    target? : PageTarget

    +

    Defined in src/extensions/registries/page-menu-registry.ts:10

    +
    +

    title#

    +

    title: React.ReactNode

    +

    Defined in src/extensions/registries/page-menu-registry.ts:11

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.pageparams/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pageparams/index.html new file mode 100644 index 0000000000..6e2d7baf29 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pageparams/index.html @@ -0,0 +1,938 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageParams ‹**V**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageParams ‹V#

    +

    Type parameters#

    +

    V

    +

    Hierarchy#

    +
      +
    • PageParams
    • +
    +

    Indexable#

    +
      +
    • [ paramName: string]: V
    • +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html new file mode 100644 index 0000000000..79777478d7 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -0,0 +1,993 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageRegistration#

    +

    Hierarchy#

    +
      +
    • PageRegistration
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageComponents

    +

    Defined in src/extensions/registries/page-registry.ts:17

    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/extensions/registries/page-registry.ts:15

    +

    Page ID, part of extension's page url, must be unique within same extension +When not provided, first registered page without "id" would be used for page-menus without target.pageId for same extension

    +
    +

    Optional params#

    +

    params? : PageParams‹string | ExtensionPageParamInit›

    +

    Defined in src/extensions/registries/page-registry.ts:16

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html new file mode 100644 index 0000000000..463f70489e --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageTarget ‹**P**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html new file mode 100644 index 0000000000..07ed99abba --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html @@ -0,0 +1,1015 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: RegisteredPage - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: RegisteredPage#

    +

    Hierarchy#

    +
      +
    • RegisteredPage
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    components: PageComponents

    +

    Defined in src/extensions/registries/page-registry.ts:48

    +
    +

    extensionId#

    +

    extensionId: string

    +

    Defined in src/extensions/registries/page-registry.ts:45

    +
    +

    id#

    +

    id: string

    +

    Defined in src/extensions/registries/page-registry.ts:44

    +
    +

    params#

    +

    params: PageParamsPageParam

    +

    Defined in src/extensions/registries/page-registry.ts:47

    +
    +

    url#

    +

    url: string

    +

    Defined in src/extensions/registries/page-registry.ts:46

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/v4.1.0/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html new file mode 100644 index 0000000000..4792b9564d --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -0,0 +1,982 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBarRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html new file mode 100644 index 0000000000..190b2670ec --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -0,0 +1,4413 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: BadgeProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: BadgeProps#

    +

    Hierarchy#

    + +

    BadgeProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional flat#

    +

    flat? : boolean

    +

    Defined in src/renderer/components/badge/badge.tsx:9

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional label#

    +

    label? : React.ReactNode

    +

    Defined in src/renderer/components/badge/badge.tsx:10

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    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:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    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:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html new file mode 100644 index 0000000000..770cb35da1 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -0,0 +1,4664 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ButtonProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ButtonProps#

    +

    Hierarchy#

    + +

    ButtonProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    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:1753

    +
    +

    Optional active#

    +

    active? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:15

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from ButtonProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1971

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional big#

    +

    big? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:16

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Inherited from ButtonProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1972

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from ButtonProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1973

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from ButtonProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1974

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from ButtonProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1975

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from ButtonProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1976

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from ButtonProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1977

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from ButtonProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1978

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Overrides IconProps.hidden

    +

    Defined in src/renderer/components/button/button.tsx:14

    +
    +

    Optional href#

    +

    href? : string

    +

    Defined in src/renderer/components/button/button.tsx:18

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    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:1761

    +
    +

    Optional light#

    +

    light? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:11

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from ButtonProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1979

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional outlined#

    +

    outlined? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:13

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional plain#

    +

    plain? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:12

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    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:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional round#

    +

    round? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:17

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : "_blank"

    +

    Defined in src/renderer/components/button/button.tsx:19

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    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:1768

    +
    +

    Optional type#

    +

    type? : "submit" | "reset" | "button"

    +

    Inherited from ButtonProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1980

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional value#

    +

    value? : string | ReadonlyArray‹string› | number

    +

    Inherited from ButtonProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1981

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional waiting#

    +

    waiting? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:8

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html new file mode 100644 index 0000000000..6c4b365c2b --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -0,0 +1,1091 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: CheckboxProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html new file mode 100644 index 0000000000..11f5b67c9f --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -0,0 +1,1041 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogParams - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ConfirmDialogParams#

    +

    Hierarchy#

    +
      +
    • ConfirmDialogParams
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional cancelButtonProps#

    +

    cancelButtonProps? : Partial‹ButtonProps

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21

    +
    +

    Optional icon#

    +

    icon? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19

    +
    +

    Optional labelCancel#

    +

    labelCancel? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17

    +
    +

    Optional labelOk#

    +

    labelOk? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16

    +
    +

    Optional message#

    +

    message? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18

    +
    +

    Optional ok#

    +

    ok? : function

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional okButtonProps#

    +

    okButtonProps? : Partial‹ButtonProps

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html new file mode 100644 index 0000000000..d7cdfab2de --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html @@ -0,0 +1,919 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ConfirmDialogProps#

    +

    Hierarchy#

    +
      +
    • object
    • +
    +

    ConfirmDialogProps

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html new file mode 100644 index 0000000000..98b0a00df8 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: CubeSpinnerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html new file mode 100644 index 0000000000..7862ec737d --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -0,0 +1,1071 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DialogProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html new file mode 100644 index 0000000000..8413cd6951 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -0,0 +1,4396 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerItemLabelsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    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:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    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:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    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:1761

    +
    +

    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:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    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:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    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:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html new file mode 100644 index 0000000000..3f0c1f6fd3 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -0,0 +1,4381 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerItemProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    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:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    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:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    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:1761

    +
    +

    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:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    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:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    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:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html new file mode 100644 index 0000000000..9865c18362 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerParamTogglerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html new file mode 100644 index 0000000000..1c46a0dbba --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -0,0 +1,1077 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html new file mode 100644 index 0000000000..547e10d72f --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerTitleProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html new file mode 100644 index 0000000000..5f1a683160 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: GroupSelectOption ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html new file mode 100644 index 0000000000..7fe3033b53 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -0,0 +1,4533 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IconProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: IconProps#

    +

    Hierarchy#

    + +

    IconProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    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:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional big#

    +

    big? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:19

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    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:1758

    +
    +

    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:1759

    +
    +

    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:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    + +

    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:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    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:1763

    +
    +

    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:1764

    +
    +

    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:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    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:1766

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    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:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html new file mode 100644 index 0000000000..13e3b1d9e4 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -0,0 +1,1062 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: InputValidator - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: InputValidator#

    +

    Hierarchy#

    +
      +
    • InputValidator
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional debounce#

    +

    debounce? : number

    +

    Defined in src/renderer/components/input/input_validators.ts:6

    +
    +

    Optional message#

    +

    message? : ReactNode | function

    +

    Defined in src/renderer/components/input/input_validators.ts:8

    +

    Methods#

    +

    Optional condition#

    +

    condition(props: InputProps): boolean

    +

    Defined in src/renderer/components/input/input_validators.ts:7

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsInputProps
    +

    Returns: boolean

    +
    +

    validate#

    +

    validate(value: string, props?: InputProps): boolean | Promise‹any›

    +

    Defined in src/renderer/components/input/input_validators.ts:9

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    valuestring
    props?InputProps
    +

    Returns: boolean | Promise‹any›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html new file mode 100644 index 0000000000..8fe23d7da2 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeEventDetailsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html new file mode 100644 index 0000000000..4ccd462087 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailsProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html new file mode 100644 index 0000000000..8533e95355 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -0,0 +1,1512 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectListLayoutProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:68

    +
    +

    className#

    +

    className: IClassName

    +

    Inherited from KubeObjectListLayoutProps.className

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40

    +
    +

    Optional copyClassNameFromHeadCells#

    +

    copyClassNameFromHeadCells? : boolean

    +

    Inherited from KubeObjectListLayoutProps.copyClassNameFromHeadCells

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:61

    +
    +

    Optional customizeHeader#

    +

    customizeHeader? : function

    +

    Inherited from KubeObjectListLayoutProps.customizeHeader

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54

    +

    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:77

    +

    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:67

    +

    Type declaration:

    +

    ▸ (item: T): Partial‹TableRowProps

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +
    +

    Optional dependentStores#

    +

    dependentStores? : KubeObjectStore[]

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:15

    +
    +

    Optional detailsItem#

    +

    detailsItem? : T

    +

    Inherited from KubeObjectListLayoutProps.detailsItem

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:73

    +
    +

    Optional filterItems#

    +

    filterItems? : ItemsFilter‹T›[]

    +

    Inherited from KubeObjectListLayoutProps.filterItems

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:48

    +
    +

    Optional hasDetailsView#

    +

    hasDetailsView? : boolean

    +

    Inherited from KubeObjectListLayoutProps.hasDetailsView

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:72

    +
    +

    Optional headerClassName#

    +

    headerClassName? : IClassName

    +

    Inherited from KubeObjectListLayoutProps.headerClassName

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52

    +
    +

    Optional hideFilters#

    +

    hideFilters? : boolean

    +

    Inherited from KubeObjectListLayoutProps.hideFilters

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46

    +
    +

    Optional isClusterScoped#

    +

    isClusterScoped? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isClusterScoped

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45

    +
    +

    Optional isConfigurable#

    +

    isConfigurable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isConfigurable

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60

    +
    +

    Optional isReady#

    +

    isReady? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isReady

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:57

    +
    +

    Optional isSearchable#

    +

    isSearchable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isSearchable

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59

    +
    +

    Optional isSelectable#

    +

    isSelectable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isSelectable

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58

    +
    +

    Optional items#

    +

    items? : T[]

    +

    Inherited from KubeObjectListLayoutProps.items

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41

    +
    +

    Optional onDetails#

    +

    onDetails? : function

    +

    Inherited from KubeObjectListLayoutProps.onDetails

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:74

    +

    Type declaration:

    +

    ▸ (item: T): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +
    +

    Optional preloadStores#

    +

    preloadStores? : boolean

    +

    Inherited from KubeObjectListLayoutProps.preloadStores

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:44

    +
    +

    Optional renderFooter#

    +

    renderFooter? : function

    +

    Inherited from KubeObjectListLayoutProps.renderFooter

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:78

    +

    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:53

    +
    +

    Optional renderItemMenu#

    +

    renderItemMenu? : function

    +

    Inherited from KubeObjectListLayoutProps.renderItemMenu

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

    +

    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:65

    +

    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:64

    +
    +

    Optional searchFilters#

    +

    searchFilters? : SearchFilter‹T›[]

    +

    Inherited from KubeObjectListLayoutProps.searchFilters

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47

    +
    +

    Optional showHeader#

    +

    showHeader? : boolean

    +

    Inherited from KubeObjectListLayoutProps.showHeader

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:51

    +
    +

    Optional sortingCallbacks#

    +

    sortingCallbacks? : object

    +

    Inherited from KubeObjectListLayoutProps.sortingCallbacks

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:62

    +

    Type declaration:

    + +
    +

    store#

    +

    store: KubeObjectStore

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:14

    +
    +

    Optional tableId#

    +

    tableId? : string

    +

    Inherited from KubeObjectListLayoutProps.tableId

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:39

    +
    +

    Optional tableProps#

    +

    tableProps? : Partial‹TableProps

    +

    Inherited from KubeObjectListLayoutProps.tableProps

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:63

    +
    +

    Optional virtual#

    +

    virtual? : boolean

    +

    Inherited from KubeObjectListLayoutProps.virtual

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:69

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html new file mode 100644 index 0000000000..6b802051eb --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html @@ -0,0 +1,1115 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectMenuProps ‹T#

    +

    Type parameters#

    +

    T: KubeObject

    +

    Hierarchy#

    +

    MenuActionsProps

    +

    KubeObjectMenuProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional autoCloseOnSelect#

    +

    autoCloseOnSelect? : boolean

    +

    Inherited from MenuActionsProps.autoCloseOnSelect

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:16

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from MenuActionsProps.className

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:14

    +
    +

    Optional editable#

    +

    editable? : boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:12

    +
    +

    object#

    +

    object: T

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:11

    +
    +

    Optional removable#

    +

    removable? : boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:13

    +
    +

    Optional removeConfirmationMessage#

    +

    removeConfirmationMessage? : React.ReactNode | function

    +

    Inherited from MenuActionsProps.removeConfirmationMessage

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:18

    +
    +

    Optional toolbar#

    +

    toolbar? : boolean

    +

    Inherited from MenuActionsProps.toolbar

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:15

    +
    +

    Optional triggerIcon#

    +

    triggerIcon? : string | IconProps | React.ReactNode

    +

    Inherited from MenuActionsProps.triggerIcon

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:17

    +

    Methods#

    +

    Optional removeAction#

    +

    removeAction(): void

    +

    Inherited from MenuActionsProps.removeAction

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:20

    +

    Returns: void

    +
    +

    Optional updateAction#

    +

    updateAction(): void

    +

    Inherited from MenuActionsProps.updateAction

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:19

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html new file mode 100644 index 0000000000..cf6a63fd5a --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMetaProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html new file mode 100644 index 0000000000..c7e05b1629 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html @@ -0,0 +1,5781 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: LineProgressProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: LineProgressProps#

    +

    Hierarchy#

    + +

    LineProgressProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accept#

    +

    accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional acceptCharset#

    +

    acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional action#

    +

    action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional allowFullScreen#

    +

    allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional allowTransparency#

    +

    allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional alt#

    +

    alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1821

    +
    +

    Optional async#

    +

    async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoComplete#

    +

    autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional autoPlay#

    +

    autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional capture#

    +

    capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional cellPadding#

    +

    cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional cellSpacing#

    +

    cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional challenge#

    +

    challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional charSet#

    +

    charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    +

    Optional checked#

    +

    checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional cite#

    +

    cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional classID#

    +

    classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    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:1835

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional cols#

    +

    cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional content#

    +

    content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional controls#

    +

    controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional coords#

    +

    coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional crossOrigin#

    +

    crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional data#

    +

    data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional dateTime#

    +

    dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional defer#

    +

    defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional download#

    +

    download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional encType#

    +

    encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional frameBorder#

    +

    frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional headers#

    +

    headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional height#

    +

    height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional high#

    +

    high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional href#

    +

    href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional hrefLang#

    +

    hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional httpEquiv#

    +

    httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1861

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional key#

    +

    key? : Key | null

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:137

    +
    +

    Optional keyParams#

    +

    keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional keyType#

    +

    keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional kind#

    +

    kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional label#

    +

    label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional list#

    +

    list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional loop#

    +

    loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional low#

    +

    low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional manifest#

    +

    manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional marginHeight#

    +

    marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional marginWidth#

    +

    marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    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:1873

    +
    +

    Optional media#

    +

    media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional mediaGroup#

    +

    mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional method#

    +

    method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    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:1878

    +
    +

    Optional multiple#

    +

    multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional muted#

    +

    muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional nonce#

    +

    nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional open#

    +

    open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional optimum#

    +

    optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional pattern#

    +

    pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional playsInline#

    +

    playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional poster#

    +

    poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    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:1780

    +
    +

    Optional preload#

    +

    preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional readOnly#

    +

    readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional ref#

    +

    ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:143

    +
    +

    Optional rel#

    +

    rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional required#

    +

    required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional reversed#

    +

    reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional rowSpan#

    +

    rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional rows#

    +

    rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional sandbox#

    +

    sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scope#

    +

    scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional scoped#

    +

    scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional scrolling#

    +

    scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional seamless#

    +

    seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional shape#

    +

    shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional size#

    +

    size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional sizes#

    +

    sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional span#

    +

    span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional src#

    +

    src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcDoc#

    +

    srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional srcLang#

    +

    srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional srcSet#

    +

    srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional start#

    +

    start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional step#

    +

    step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional summary#

    +

    summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    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:1768

    +
    +

    Optional type#

    +

    type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional useMap#

    +

    useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    value#

    +

    value: number

    +

    Overrides MenuItemProps.value

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:7

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional width#

    +

    width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    +
    +

    Optional wmode#

    +

    wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1919

    +
    +

    Optional wrap#

    +

    wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1920

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html new file mode 100644 index 0000000000..7073988cb4 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html @@ -0,0 +1,1066 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuActionsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuActionsProps#

    +

    Hierarchy#

    +
      +
    • object
    • +
    +

    MenuActionsProps

    +

    KubeObjectMenuProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional autoCloseOnSelect#

    +

    autoCloseOnSelect? : boolean

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:16

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:14

    +
    +

    Optional removeConfirmationMessage#

    +

    removeConfirmationMessage? : React.ReactNode | function

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:18

    +
    +

    Optional toolbar#

    +

    toolbar? : boolean

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:15

    +
    +

    Optional triggerIcon#

    +

    triggerIcon? : string | IconProps | React.ReactNode

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:17

    +

    Methods#

    +

    Optional removeAction#

    +

    removeAction(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:20

    +

    Returns: void

    +
    +

    Optional updateAction#

    +

    updateAction(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:19

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html new file mode 100644 index 0000000000..018110d667 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html @@ -0,0 +1,5772 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuItemProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1777

    +
    +

    Optional accept#

    +

    accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional acceptCharset#

    +

    acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional action#

    +

    action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional active#

    +

    active? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:300

    +
    +

    Optional allowFullScreen#

    +

    allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional allowTransparency#

    +

    allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional alt#

    +

    alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1821

    +
    +

    Optional async#

    +

    async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoComplete#

    +

    autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional autoPlay#

    +

    autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional capture#

    +

    capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional cellPadding#

    +

    cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional cellSpacing#

    +

    cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional challenge#

    +

    challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional charSet#

    +

    charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    +

    Optional checked#

    +

    checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional cite#

    +

    cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional classID#

    +

    classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional colSpan#

    +

    colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional cols#

    +

    cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional content#

    +

    content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional controls#

    +

    controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional coords#

    +

    coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional crossOrigin#

    +

    crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional data#

    +

    data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional dateTime#

    +

    dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional defer#

    +

    defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Overrides LineProgressProps.disabled

    +

    Defined in src/renderer/components/menu/menu.tsx:299

    +
    +

    Optional download#

    +

    download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional encType#

    +

    encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional frameBorder#

    +

    frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional headers#

    +

    headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional height#

    +

    height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional high#

    +

    high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional href#

    +

    href? : string

    +

    Overrides LineProgressProps.href

    +

    Defined in src/renderer/components/menu/menu.tsx:302

    +
    +

    Optional hrefLang#

    +

    hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional httpEquiv#

    +

    httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional icon#

    +

    icon? : string | Partial‹IconProps

    +

    Defined in src/renderer/components/menu/menu.tsx:298

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1861

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional key#

    +

    key? : Key | null

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:137

    +
    +

    Optional keyParams#

    +

    keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional keyType#

    +

    keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional kind#

    +

    kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional label#

    +

    label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional list#

    +

    list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional loop#

    +

    loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional low#

    +

    low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional manifest#

    +

    manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional marginHeight#

    +

    marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional marginWidth#

    +

    marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional max#

    +

    max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional maxLength#

    +

    maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional media#

    +

    media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional mediaGroup#

    +

    mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional method#

    +

    method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional min#

    +

    min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional minLength#

    +

    minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional multiple#

    +

    multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional muted#

    +

    muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional nonce#

    +

    nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional open#

    +

    open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional optimum#

    +

    optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional pattern#

    +

    pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional playsInline#

    +

    playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional poster#

    +

    poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional preload#

    +

    preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional readOnly#

    +

    readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional ref#

    +

    ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:143

    +
    +

    Optional rel#

    +

    rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional required#

    +

    required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional reversed#

    +

    reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional rowSpan#

    +

    rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional rows#

    +

    rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional sandbox#

    +

    sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scope#

    +

    scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional scoped#

    +

    scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional scrolling#

    +

    scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional seamless#

    +

    seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional shape#

    +

    shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional size#

    +

    size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional sizes#

    +

    sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spacer#

    +

    spacer? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:301

    +
    +

    Optional span#

    +

    span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional src#

    +

    src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcDoc#

    +

    srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional srcLang#

    +

    srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional srcSet#

    +

    srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional start#

    +

    start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional step#

    +

    step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional summary#

    +

    summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional type#

    +

    type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional useMap#

    +

    useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional value#

    +

    value? : string | ReadonlyArray‹string› | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional width#

    +

    width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    +
    +

    Optional wmode#

    +

    wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1919

    +
    +

    Optional wrap#

    +

    wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1920

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html new file mode 100644 index 0000000000..727480ffa4 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuPosition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html new file mode 100644 index 0000000000..50f434dc96 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html @@ -0,0 +1,1148 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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 toggleEvent#

    +

    toggleEvent? : "click" | "contextmenu"

    +

    Defined in src/renderer/components/menu/menu.tsx:34

    +
    +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.notification/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.notification/index.html new file mode 100644 index 0000000000..a5b6566f37 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.notification/index.html @@ -0,0 +1,1039 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: Notification - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: Notification#

    +

    Hierarchy#

    +
      +
    • Notification
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional id#

    +

    id? : NotificationId

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:17

    +
    +

    message#

    +

    message: NotificationMessage

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:18

    +
    +

    Optional status#

    +

    status? : NotificationStatus

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:19

    +
    +

    Optional timeout#

    +

    timeout? : number

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:20

    +

    Methods#

    +

    Optional onClose#

    +

    onClose(): void

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:21

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html new file mode 100644 index 0000000000..6ba0616802 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html @@ -0,0 +1,3179 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1350

    +
    +

    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:1351

    +

    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:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html new file mode 100644 index 0000000000..7caecf5a6d --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html @@ -0,0 +1,1054 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: RadioGroupProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html new file mode 100644 index 0000000000..a85bff11f2 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SelectOption ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html new file mode 100644 index 0000000000..746d643432 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -0,0 +1,2253 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SelectProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html new file mode 100644 index 0000000000..5030e0a212 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -0,0 +1,1023 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SliderProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html new file mode 100644 index 0000000000..48618f27c5 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -0,0 +1,5772 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SpinnerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1777

    +
    +

    Optional accept#

    +

    accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional acceptCharset#

    +

    acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional action#

    +

    action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional allowFullScreen#

    +

    allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional allowTransparency#

    +

    allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional alt#

    +

    alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1821

    +
    +

    Optional async#

    +

    async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoComplete#

    +

    autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional autoPlay#

    +

    autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional capture#

    +

    capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional cellPadding#

    +

    cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional cellSpacing#

    +

    cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    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:1830

    +
    +

    Optional charSet#

    +

    charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    +

    Optional checked#

    +

    checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional cite#

    +

    cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional classID#

    +

    classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional colSpan#

    +

    colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional cols#

    +

    cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional content#

    +

    content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional controls#

    +

    controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional coords#

    +

    coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional crossOrigin#

    +

    crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional data#

    +

    data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional dateTime#

    +

    dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional defer#

    +

    defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional download#

    +

    download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional encType#

    +

    encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional frameBorder#

    +

    frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional headers#

    +

    headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional height#

    +

    height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional high#

    +

    high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional href#

    +

    href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional hrefLang#

    +

    hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional httpEquiv#

    +

    httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1861

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional key#

    +

    key? : Key | null

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:137

    +
    +

    Optional keyParams#

    +

    keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional keyType#

    +

    keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional kind#

    +

    kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional label#

    +

    label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional list#

    +

    list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional loop#

    +

    loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional low#

    +

    low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional manifest#

    +

    manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional marginHeight#

    +

    marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional marginWidth#

    +

    marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional max#

    +

    max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional maxLength#

    +

    maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional media#

    +

    media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional mediaGroup#

    +

    mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional method#

    +

    method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional min#

    +

    min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional minLength#

    +

    minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional multiple#

    +

    multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional muted#

    +

    muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional nonce#

    +

    nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional open#

    +

    open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional optimum#

    +

    optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional pattern#

    +

    pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional playsInline#

    +

    playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional poster#

    +

    poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional preload#

    +

    preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional readOnly#

    +

    readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional ref#

    +

    ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:143

    +
    +

    Optional rel#

    +

    rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional required#

    +

    required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional reversed#

    +

    reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional rowSpan#

    +

    rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional rows#

    +

    rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional sandbox#

    +

    sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scope#

    +

    scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional scoped#

    +

    scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional scrolling#

    +

    scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional seamless#

    +

    seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional shape#

    +

    shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    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:1904

    +
    +

    Optional sizes#

    +

    sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional span#

    +

    span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional src#

    +

    src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcDoc#

    +

    srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional srcLang#

    +

    srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional srcSet#

    +

    srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional start#

    +

    start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional step#

    +

    step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional summary#

    +

    summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional type#

    +

    type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional useMap#

    +

    useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional value#

    +

    value? : string | ReadonlyArray‹string› | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional width#

    +

    width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    +
    +

    Optional wmode#

    +

    wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1919

    +
    +

    Optional wrap#

    +

    wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1920

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html new file mode 100644 index 0000000000..7a7600f7fb --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -0,0 +1,4377 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBrickProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: StatusBrickProps#

    +

    Hierarchy#

    + +

    StatusBrickProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1787

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional style#

    +

    style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    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:1768

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html new file mode 100644 index 0000000000..38cb8bdc44 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -0,0 +1,5748 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StepperProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1777

    +
    +

    Optional accept#

    +

    accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional acceptCharset#

    +

    acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional accessKey#

    +

    accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional action#

    +

    action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional allowFullScreen#

    +

    allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional allowTransparency#

    +

    allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional alt#

    +

    alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional aria-activedescendant#

    +

    aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    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:1562

    +

    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:1567

    +

    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:1569

    +

    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:1574

    +

    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:1579

    +

    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:1584

    +

    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:1589

    +

    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:1594

    +

    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:1596

    +

    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:1601

    +

    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:1606

    +

    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:1611

    +

    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:1616

    +

    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:1621

    +

    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:1623

    +

    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:1628

    +

    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:1633

    +

    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:1635

    +

    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:1640

    +

    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:1645

    +

    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:1647

    +

    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:1652

    +

    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:1657

    +

    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:1659

    +

    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:1661

    +

    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:1663

    +

    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:1665

    +

    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:1667

    +

    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:1669

    +

    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:1675

    +

    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:1680

    +

    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:1685

    +

    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:1690

    +

    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:1695

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    aria-relevant? : "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    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:1702

    +

    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:1704

    +

    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:1709

    +

    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:1714

    +

    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:1719

    +

    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:1724

    +

    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:1729

    +

    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:1731

    +

    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:1733

    +

    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:1735

    +

    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:1740

    +

    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:1742

    +

    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:1821

    +
    +

    Optional async#

    +

    async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoCapitalize#

    +

    autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional autoComplete#

    +

    autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoCorrect#

    +

    autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional autoFocus#

    +

    autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional autoPlay#

    +

    autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional autoSave#

    +

    autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional capture#

    +

    capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional cellPadding#

    +

    cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional cellSpacing#

    +

    cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional challenge#

    +

    challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional charSet#

    +

    charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    +

    Optional checked#

    +

    checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional cite#

    +

    cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional classID#

    +

    classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional className#

    +

    className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional colSpan#

    +

    colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional color#

    +

    color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional cols#

    +

    cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional content#

    +

    content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional contentEditable#

    +

    contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional contextMenu#

    +

    contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional controls#

    +

    controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional coords#

    +

    coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional crossOrigin#

    +

    crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional data#

    +

    data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional datatype#

    +

    datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional dateTime#

    +

    dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional default#

    +

    default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional defaultChecked#

    +

    defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional defaultValue#

    +

    defaultValue? : string | number | ReadonlyArray‹string›

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional defer#

    +

    defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional dir#

    +

    dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional download#

    +

    download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional draggable#

    +

    draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional encType#

    +

    encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional form#

    +

    form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formAction#

    +

    formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formEncType#

    +

    formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formMethod#

    +

    formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional formNoValidate#

    +

    formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional formTarget#

    +

    formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional frameBorder#

    +

    frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional headers#

    +

    headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional height#

    +

    height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hidden#

    +

    hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional high#

    +

    high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional href#

    +

    href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional hrefLang#

    +

    hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional htmlFor#

    +

    htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional httpEquiv#

    +

    httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional id#

    +

    id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional inlist#

    +

    inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional inputMode#

    +

    inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1805

    +

    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:1861

    +
    +

    Optional is#

    +

    is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1810

    +

    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:1794

    +
    +

    Optional itemProp#

    +

    itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional itemRef#

    +

    itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional itemScope#

    +

    itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemType#

    +

    itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional key#

    +

    key? : Key | null

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:137

    +
    +

    Optional keyParams#

    +

    keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional keyType#

    +

    keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional kind#

    +

    kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional label#

    +

    label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional lang#

    +

    lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional list#

    +

    list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional loop#

    +

    loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional low#

    +

    low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional manifest#

    +

    manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional marginHeight#

    +

    marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional marginWidth#

    +

    marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional max#

    +

    max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional maxLength#

    +

    maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional media#

    +

    media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional mediaGroup#

    +

    mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional method#

    +

    method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional min#

    +

    min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional minLength#

    +

    minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional multiple#

    +

    multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional muted#

    +

    muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional name#

    +

    name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional nonce#

    +

    nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional open#

    +

    open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional optimum#

    +

    optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional pattern#

    +

    pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional placeholder#

    +

    placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional playsInline#

    +

    playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional poster#

    +

    poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional prefix#

    +

    prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional preload#

    +

    preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional property#

    +

    property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional radioGroup#

    +

    radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1771

    +
    +

    Optional readOnly#

    +

    readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional ref#

    +

    ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:143

    +
    +

    Optional rel#

    +

    rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional required#

    +

    required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional resource#

    +

    resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional results#

    +

    results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional reversed#

    +

    reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional role#

    +

    role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1774

    +
    +

    Optional rowSpan#

    +

    rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional rows#

    +

    rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional sandbox#

    +

    sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scope#

    +

    scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional scoped#

    +

    scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional scrolling#

    +

    scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional seamless#

    +

    seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional security#

    +

    security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1797

    +
    +

    Optional selected#

    +

    selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional shape#

    +

    shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional size#

    +

    size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional sizes#

    +

    sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional slot#

    +

    slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional span#

    +

    span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional spellCheck#

    +

    spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional src#

    +

    src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcDoc#

    +

    srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional srcLang#

    +

    srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional srcSet#

    +

    srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional start#

    +

    start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    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:1765

    +
    +

    Optional summary#

    +

    summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional suppressContentEditableWarning#

    +

    suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1749

    +
    +

    Optional suppressHydrationWarning#

    +

    suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1750

    +
    +

    Optional tabIndex#

    +

    tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional target#

    +

    target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional title#

    +

    title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1767

    +
    +

    Optional translate#

    +

    translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1768

    +
    +

    Optional type#

    +

    type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    +

    Optional typeof#

    +

    typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1783

    +
    +

    Optional unselectable#

    +

    unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1798

    +
    +

    Optional useMap#

    +

    useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional value#

    +

    value? : string | ReadonlyArray‹string› | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional vocab#

    +

    vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1784

    +
    +

    Optional width#

    +

    width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    +
    +

    Optional wmode#

    +

    wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1919

    +
    +

    Optional wrap#

    +

    wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1920

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html new file mode 100644 index 0000000000..7554a6bdb4 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html new file mode 100644 index 0000000000..34b7a6e491 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -0,0 +1,1027 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabLayoutRoute - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html new file mode 100644 index 0000000000..c3dd9a9186 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -0,0 +1,3237 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableCellProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableCellProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
    • +
    +

    TableCellProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional _nowrap#

    +

    _nowrap? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:22

    +
    +

    Optional _sorting#

    +

    _sorting? : Partial‹TableSortParams

    +

    Defined in src/renderer/components/table/table-cell.tsx:20

    +
    +

    Optional checkbox#

    +

    checkbox? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:15

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/table/table-cell.tsx:13

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/renderer/components/table/table-cell.tsx:12

    +
    +

    Optional isChecked#

    +

    isChecked? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:16

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional renderBoolean#

    +

    renderBoolean? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:17

    +
    +

    Optional showWithColumn#

    +

    showWithColumn? : string

    +

    Defined in src/renderer/components/table/table-cell.tsx:19

    +
    +

    Optional sortBy#

    +

    sortBy? : TableSortBy

    +

    Defined in src/renderer/components/table/table-cell.tsx:18

    +
    +

    Optional title#

    +

    title? : ReactNode

    +

    Defined in src/renderer/components/table/table-cell.tsx:14

    +

    Methods#

    +

    Optional _sort#

    +

    _sort(sortBy: TableSortBy): void

    +

    Defined in src/renderer/components/table/table-cell.tsx:21

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    sortByTableSortBy
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html new file mode 100644 index 0000000000..38455c435d --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -0,0 +1,3114 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableHeadProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1350

    +
    +

    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:1351

    +

    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:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html new file mode 100644 index 0000000000..c883fdc016 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -0,0 +1,3333 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
    • +
    +

    TableProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional autoSize#

    +

    autoSize? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:23

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/table/table.tsx:22

    +
    +

    Optional customRowHeights#

    +

    customRowHeights? : function

    +

    Defined in src/renderer/components/table/table.tsx:40

    +

    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:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional getTableRow#

    +

    getTableRow? : function

    +

    Defined in src/renderer/components/table/table.tsx:41

    +

    Type declaration:

    +

    ▸ (uid: string): ReactElement‹TableRowProps

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    uidstring
    +
    +

    Optional items#

    +

    items? : ItemObject[]

    +

    Defined in src/renderer/components/table/table.tsx:21

    +
    +

    Optional noItems#

    +

    noItems? : React.ReactNode

    +

    Defined in src/renderer/components/table/table.tsx:35

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onSort#

    +

    onSort? : function

    +

    Defined in src/renderer/components/table/table.tsx:34

    +

    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:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    Optional rowLineHeight#

    +

    rowLineHeight? : string

    +

    Defined in src/renderer/components/table/table.tsx:39

    +
    +

    Optional rowPadding#

    +

    rowPadding? : string

    +

    Defined in src/renderer/components/table/table.tsx:38

    +
    +

    Optional scrollable#

    +

    scrollable? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:25

    +
    +

    Optional selectable#

    +

    selectable? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:24

    +
    +

    Optional selectedItemId#

    +

    selectedItemId? : string

    +

    Defined in src/renderer/components/table/table.tsx:36

    +
    +

    Optional sortByDefault#

    +

    sortByDefault? : Partial‹TableSortParams

    +

    Defined in src/renderer/components/table/table.tsx:33

    +
    +

    Optional sortSyncWithUrl#

    +

    sortSyncWithUrl? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:32

    +
    +

    Optional sortable#

    +

    sortable? : object

    +

    Defined in src/renderer/components/table/table.tsx:27

    +

    Type declaration:

    + +
    +

    Optional storageKey#

    +

    storageKey? : string

    +

    Defined in src/renderer/components/table/table.tsx:26

    +
    +

    Optional virtual#

    +

    virtual? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:37

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html new file mode 100644 index 0000000000..518313b61b --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html @@ -0,0 +1,3150 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableRowProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1350

    +
    +

    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:1351

    +

    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:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html new file mode 100644 index 0000000000..faa332b438 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html @@ -0,0 +1,3159 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:56

    +
    +

    Optional children#

    +

    children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1350

    +
    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:55

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1351

    +

    Type declaration:

    +
      +
    • __html: string
    • +
    +
    +

    Optional disabled#

    +

    disabled? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:57

    +
    +

    Optional icon#

    +

    icon? : React.ReactNode | string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:58

    +
    +

    Optional id#

    +

    id? : string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:54

    +
    +

    Optional label#

    +

    label? : React.ReactNode

    +

    Defined in src/renderer/components/tabs/tabs.tsx:59

    +
    +

    Optional onAbort#

    +

    onAbort? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    +
    +

    value#

    +

    value: D

    +

    Defined in src/renderer/components/tabs/tabs.tsx:60

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html new file mode 100644 index 0000000000..9563cf4ac4 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html @@ -0,0 +1,1109 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabsProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html new file mode 100644 index 0000000000..3d67e4311b --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -0,0 +1,1015 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipContentFormatters - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html new file mode 100644 index 0000000000..cdbc3eba34 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -0,0 +1,986 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipDecoratorProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html new file mode 100644 index 0000000000..76189e1465 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -0,0 +1,1075 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html new file mode 100644 index 0000000000..cead460bff --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -0,0 +1,3150 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:1350

    +
    +

    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:1351

    +

    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:1406

    +
    +

    Optional onAbortCapture#

    +

    onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onAnimationEnd#

    +

    onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationEndCapture#

    +

    onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationIteration#

    +

    onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1538

    +
    +

    Optional onAnimationIterationCapture#

    +

    onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1539

    +
    +

    Optional onAnimationStart#

    +

    onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationStartCapture#

    +

    onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAuxClick#

    +

    onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onAuxClickCapture#

    +

    onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onBeforeInput#

    +

    onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onBeforeInputCapture#

    +

    onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onBlur#

    +

    onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1374

    +
    +

    Optional onBlurCapture#

    +

    onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1375

    +
    +

    Optional onCanPlay#

    +

    onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayCapture#

    +

    onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onCanPlayThrough#

    +

    onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onCanPlayThroughCapture#

    +

    onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onChange#

    +

    onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onChangeCapture#

    +

    onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onClick#

    +

    onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onClickCapture#

    +

    onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCompositionEnd#

    +

    onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionEndCapture#

    +

    onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionStart#

    +

    onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionStartCapture#

    +

    onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onCompositionUpdate#

    +

    onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1368

    +
    +

    Optional onCompositionUpdateCapture#

    +

    onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1369

    +
    +

    Optional onContextMenu#

    +

    onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onContextMenuCapture#

    +

    onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onCopy#

    +

    onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCopyCapture#

    +

    onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onCut#

    +

    onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onCutCapture#

    +

    onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onDoubleClick#

    +

    onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDoubleClickCapture#

    +

    onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDrag#

    +

    onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragCapture#

    +

    onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnd#

    +

    onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEndCapture#

    +

    onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragEnter#

    +

    onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragEnterCapture#

    +

    onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragExit#

    +

    onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragExitCapture#

    +

    onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragLeave#

    +

    onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragLeaveCapture#

    +

    onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragOver#

    +

    onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragOverCapture#

    +

    onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDragStart#

    +

    onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDragStartCapture#

    +

    onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDrop#

    +

    onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onDropCapture#

    +

    onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onDurationChange#

    +

    onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onDurationChangeCapture#

    +

    onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEmptied#

    +

    onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEmptiedCapture#

    +

    onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEncrypted#

    +

    onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEncryptedCapture#

    +

    onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onEnded#

    +

    onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onEndedCapture#

    +

    onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onError#

    +

    onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1394

    +
    +

    Optional onErrorCapture#

    +

    onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1395

    +
    +

    Optional onFocus#

    +

    onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onFocusCapture#

    +

    onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onGotPointerCapture#

    +

    onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onInput#

    +

    onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onInputCapture#

    +

    onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onInvalid#

    +

    onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1388

    +
    +

    Optional onInvalidCapture#

    +

    onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1389

    +
    +

    Optional onKeyDown#

    +

    onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyDownCapture#

    +

    onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyPress#

    +

    onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyPressCapture#

    +

    onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onKeyUp#

    +

    onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1402

    +
    +

    Optional onKeyUpCapture#

    +

    onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1403

    +
    +

    Optional onLoad#

    +

    onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onLoadCapture#

    +

    onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onLoadStart#

    +

    onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onLoadStartCapture#

    +

    onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onLoadedData#

    +

    onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedDataCapture#

    +

    onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLoadedMetadata#

    +

    onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadedMetadataCapture#

    +

    onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLostPointerCapture#

    +

    onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1522

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1523

    +
    +

    Optional onMouseDown#

    +

    onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseDownCapture#

    +

    onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseEnter#

    +

    onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseLeave#

    +

    onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseMove#

    +

    onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseMoveCapture#

    +

    onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOut#

    +

    onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOutCapture#

    +

    onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseOver#

    +

    onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseOverCapture#

    +

    onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onMouseUp#

    +

    onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1486

    +
    +

    Optional onMouseUpCapture#

    +

    onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1487

    +
    +

    Optional onPaste#

    +

    onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1360

    +
    +

    Optional onPasteCapture#

    +

    onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1361

    +
    +

    Optional onPause#

    +

    onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPauseCapture#

    +

    onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlay#

    +

    onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayCapture#

    +

    onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPlaying#

    +

    onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onPlayingCapture#

    +

    onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onPointerCancel#

    +

    onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerCancelCapture#

    +

    onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerDown#

    +

    onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerDownCapture#

    +

    onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerEnter#

    +

    onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerEnterCapture#

    +

    onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerLeave#

    +

    onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerLeaveCapture#

    +

    onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerMove#

    +

    onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerMoveCapture#

    +

    onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onPointerOut#

    +

    onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onPointerOutCapture#

    +

    onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onPointerOver#

    +

    onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOverCapture#

    +

    onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerUp#

    +

    onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerUpCapture#

    +

    onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onProgress#

    +

    onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onProgressCapture#

    +

    onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onRateChange#

    +

    onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onRateChangeCapture#

    +

    onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onReset#

    +

    onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onResetCapture#

    +

    onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onScroll#

    +

    onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1526

    +
    +

    Optional onScrollCapture#

    +

    onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1527

    +
    +

    Optional onSeeked#

    +

    onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekedCapture#

    +

    onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSeeking#

    +

    onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onSeekingCapture#

    +

    onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSelect#

    +

    onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1490

    +
    +

    Optional onSelectCapture#

    +

    onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1491

    +
    +

    Optional onStalled#

    +

    onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onStalledCapture#

    +

    onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onSubmit#

    +

    onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onSubmitCapture#

    +

    onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onSuspend#

    +

    onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onSuspendCapture#

    +

    onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTimeUpdate#

    +

    onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onTimeUpdateCapture#

    +

    onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onTouchCancel#

    +

    onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchCancelCapture#

    +

    onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchEnd#

    +

    onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchEndCapture#

    +

    onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchMove#

    +

    onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchMoveCapture#

    +

    onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTouchStart#

    +

    onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1500

    +
    +

    Optional onTouchStartCapture#

    +

    onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1501

    +
    +

    Optional onTransitionEnd#

    +

    onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1542

    +
    +

    Optional onTransitionEndCapture#

    +

    onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1543

    +
    +

    Optional onVolumeChange#

    +

    onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onVolumeChangeCapture#

    +

    onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWaiting#

    +

    onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1448

    +
    +

    Optional onWaitingCapture#

    +

    onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1449

    +
    +

    Optional onWheel#

    +

    onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1530

    +
    +

    Optional onWheelCapture#

    +

    onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1531

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html new file mode 100644 index 0000000000..a7fcd9872c --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html @@ -0,0 +1,1117 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: WizardProps ‹D#

    +

    Type parameters#

    +

    D

    +

    Hierarchy#

    +
      +
    • WizardCommonProps
    • +
    +

    WizardProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional className#

    +

    className? : string

    +

    Defined in src/renderer/components/wizard/wizard.tsx:18

    +
    +

    Optional data#

    +

    data? : Partial‹D›

    +

    Inherited from WizardProps.data

    +

    Defined in src/renderer/components/wizard/wizard.tsx:10

    +
    +

    Optional done#

    +

    done? : function

    +

    Inherited from WizardProps.done

    +

    Defined in src/renderer/components/wizard/wizard.tsx:13

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional header#

    +

    header? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:21

    +
    +

    Optional hideSteps#

    +

    hideSteps? : boolean

    +

    Inherited from WizardProps.hideSteps

    +

    Defined in src/renderer/components/wizard/wizard.tsx:14

    +
    +

    Optional onChange#

    +

    onChange? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:22

    +

    Type declaration:

    +

    ▸ (step: number): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    stepnumber
    +
    +

    Optional reset#

    +

    reset? : function

    +

    Inherited from WizardProps.reset

    +

    Defined in src/renderer/components/wizard/wizard.tsx:12

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional save#

    +

    save? : function

    +

    Inherited from WizardProps.save

    +

    Defined in src/renderer/components/wizard/wizard.tsx:11

    +

    Type declaration:

    +

    ▸ (data: Partial‹D›, callback?: function): void

    +

    Parameters:

    +

    data: Partial‹D›

    +

    Optional callback: function

    +

    ▸ (): void

    +
    +

    Optional step#

    +

    step? : number

    +

    Defined in src/renderer/components/wizard/wizard.tsx:19

    +
    +

    Optional title#

    +

    title? : string

    +

    Defined in src/renderer/components/wizard/wizard.tsx:20

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html new file mode 100644 index 0000000000..fe88f29730 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html @@ -0,0 +1,1352 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardStepProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Interface: WizardStepProps ‹D#

    +

    Type parameters#

    +

    D

    +

    Hierarchy#

    +
      +
    • WizardCommonProps‹D›
    • +
    +

    WizardStepProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional afterContent#

    +

    afterContent? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:122

    +
    +

    Optional beforeContent#

    +

    beforeContent? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:121

    +
    +

    Optional className#

    +

    className? : string | object

    +

    Defined in src/renderer/components/wizard/wizard.tsx:103

    +
    +

    Optional contentClass#

    +

    contentClass? : string | object

    +

    Defined in src/renderer/components/wizard/wizard.tsx:104

    +
    +

    Optional customButtons#

    +

    customButtons? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:105

    +
    +

    Optional data#

    +

    data? : Partial‹D›

    +

    Inherited from WizardProps.data

    +

    Defined in src/renderer/components/wizard/wizard.tsx:10

    +
    +

    Optional disabledNext#

    +

    disabledNext? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:109

    +
    +

    Optional done#

    +

    done? : function

    +

    Inherited from WizardProps.done

    +

    Defined in src/renderer/components/wizard/wizard.tsx:13

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional first#

    +

    first? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:117

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional hideBackBtn#

    +

    hideBackBtn? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:111

    +
    +

    Optional hideNextBtn#

    +

    hideNextBtn? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:110

    +
    +

    Optional hideSteps#

    +

    hideSteps? : boolean

    +

    Inherited from WizardProps.hideSteps

    +

    Defined in src/renderer/components/wizard/wizard.tsx:14

    +
    +

    Optional isFirst#

    +

    isFirst? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:119

    +

    Type declaration:

    +

    ▸ (): boolean

    +
    +

    Optional isLast#

    +

    isLast? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:120

    +

    Type declaration:

    +

    ▸ (): boolean

    +
    +

    Optional last#

    +

    last? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:118

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional loading#

    +

    loading? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:107

    +
    +

    Optional moreButtons#

    +

    moreButtons? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:106

    +
    +

    Optional next#

    +

    next? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:115

    +

    Type declaration:

    +

    ▸ (): void | boolean | Promise‹any›

    +
    +

    Optional nextLabel#

    +

    nextLabel? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:114

    +
    +

    Optional noValidate#

    +

    noValidate? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:123

    +
    +

    Optional prev#

    +

    prev? : function

    +

    Defined in src/renderer/components/wizard/wizard.tsx:116

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional prevLabel#

    +

    prevLabel? : React.ReactNode

    +

    Defined in src/renderer/components/wizard/wizard.tsx:113

    +
    +

    Optional reset#

    +

    reset? : function

    +

    Inherited from WizardProps.reset

    +

    Defined in src/renderer/components/wizard/wizard.tsx:12

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional save#

    +

    save? : function

    +

    Inherited from WizardProps.save

    +

    Defined in src/renderer/components/wizard/wizard.tsx:11

    +

    Type declaration:

    +

    ▸ (data: Partial‹D›, callback?: function): void

    +

    Parameters:

    +

    data: Partial‹D›

    +

    Optional callback: function

    +

    ▸ (): void

    +
    +

    Optional scrollable#

    +

    scrollable? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:125

    +
    +

    Optional skip#

    +

    skip? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:124

    +
    +

    Optional step#

    +

    step? : number

    +

    Defined in src/renderer/components/wizard/wizard.tsx:112

    +
    +

    Optional title#

    +

    title? : string

    +

    Defined in src/renderer/components/wizard/wizard.tsx:102

    +
    +

    Optional waiting#

    +

    waiting? : boolean

    +

    Defined in src/renderer/components/wizard/wizard.tsx:108

    +
    +

    Optional wizard#

    +

    wizard? : Wizard

    +

    Defined in src/renderer/components/wizard/wizard.tsx:101

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html new file mode 100644 index 0000000000..df8a1398ba --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IKubeApiCluster - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html new file mode 100644 index 0000000000..02d0e2ce3c --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html @@ -0,0 +1,1132 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IPodContainer - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:119

    +
    +

    Optional livenessProbe#

    +

    livenessProbe? : IContainerProbe

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:116

    +
    +

    name#

    +

    name: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:66

    +
    +

    Optional 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:117

    +
    +

    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 startupProbe#

    +

    startupProbe? : IContainerProbe

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:118

    +
    +

    Optional volumeMounts#

    +

    volumeMounts? : object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:111

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html new file mode 100644 index 0000000000..af00787afb --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html @@ -0,0 +1,1135 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IPodContainerStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: IPodContainerStatus#

    +

    Hierarchy#

    +
      +
    • IPodContainerStatus
    • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional containerID#

    +

    containerID? : string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:180

    +
    +

    image#

    +

    image: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:178

    +
    +

    imageID#

    +

    imageID: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:179

    +
    +

    Optional lastState#

    +

    lastState? : object

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:160

    +

    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

      +
    • +
    +
    +

    name#

    +

    name: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:143

    +
    +

    ready#

    +

    ready: boolean

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:176

    +
    +

    restartCount#

    +

    restartCount: number

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:177

    +
    +

    Optional started#

    +

    started? : boolean

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:181

    +
    +

    Optional state#

    +

    state? : object

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:144

    +

    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.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html new file mode 100644 index 0000000000..312c61762a --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ISecretRef - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html new file mode 100644 index 0000000000..d86614bda6 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html @@ -0,0 +1,989 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IURLParams ‹**P, Q**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html b/v4.1.0/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html new file mode 100644 index 0000000000..e8fd9c4944 --- /dev/null +++ b/v4.1.0/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html @@ -0,0 +1,1115 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageParamInit ‹**V**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageParamInit ‹V#

    +

    Type parameters#

    +

    V

    +

    Hierarchy#

    +
      +
    • PageParamInit
    • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional defaultValue#

    +

    defaultValue? : V

    +

    Defined in src/renderer/navigation/page-param.ts:6

    +
    +

    Optional defaultValueStringified#

    +

    defaultValueStringified? : string | string[]

    +

    Defined in src/renderer/navigation/page-param.ts:7

    +
    +

    Optional multiValueSep#

    +

    multiValueSep? : string

    +

    Defined in src/renderer/navigation/page-param.ts:9

    +
    +

    Optional multiValues#

    +

    multiValues? : boolean

    +

    Defined in src/renderer/navigation/page-param.ts:8

    +
    +

    name#

    +

    name: string

    +

    Defined in src/renderer/navigation/page-param.ts:5

    +
    +

    Optional skipEmpty#

    +

    skipEmpty? : boolean

    +

    Defined in src/renderer/navigation/page-param.ts:10

    +

    Methods#

    +

    Optional parse#

    +

    parse(value: string[]): V

    +

    Defined in src/renderer/navigation/page-param.ts:11

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuestring[]
    +

    Returns: V

    +
    +

    Optional stringify#

    +

    stringify(value: V): string | string[]

    +

    Defined in src/renderer/navigation/page-param.ts:12

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valueV
    +

    Returns: string | string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/modules/_core_api_app_/index.html b/v4.1.0/extensions/api/modules/_core_api_app_/index.html new file mode 100644 index 0000000000..abd9fc7142 --- /dev/null +++ b/v4.1.0/extensions/api/modules/_core_api_app_/index.html @@ -0,0 +1,1076 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/app" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/modules/_core_api_cluster_feature_/index.html b/v4.1.0/extensions/api/modules/_core_api_cluster_feature_/index.html new file mode 100644 index 0000000000..283d2d8e49 --- /dev/null +++ b/v4.1.0/extensions/api/modules/_core_api_cluster_feature_/index.html @@ -0,0 +1,943 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/cluster-feature" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/modules/_core_api_event_bus_/index.html b/v4.1.0/extensions/api/modules/_core_api_event_bus_/index.html new file mode 100644 index 0000000000..4d9696abde --- /dev/null +++ b/v4.1.0/extensions/api/modules/_core_api_event_bus_/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/event-bus" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/modules/_core_api_stores_/index.html b/v4.1.0/extensions/api/modules/_core_api_stores_/index.html new file mode 100644 index 0000000000..a3cd2b9842 --- /dev/null +++ b/v4.1.0/extensions/api/modules/_core_api_stores_/index.html @@ -0,0 +1,1042 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/stores" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/api/modules/_core_api_utils_/index.html b/v4.1.0/extensions/api/modules/_core_api_utils_/index.html new file mode 100644 index 0000000000..1ed716a87b --- /dev/null +++ b/v4.1.0/extensions/api/modules/_core_api_utils_/index.html @@ -0,0 +1,1072 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/utils" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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#

    +

    prevDefaultE›(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.1.0/extensions/api/modules/_interfaces_index_/index.html b/v4.1.0/extensions/api/modules/_interfaces_index_/index.html new file mode 100644 index 0000000000..42f5b3fd25 --- /dev/null +++ b/v4.1.0/extensions/api/modules/_interfaces_index_/index.html @@ -0,0 +1,950 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "interfaces/index" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + + +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/modules/_renderer_api_components_/index.html b/v4.1.0/extensions/api/modules/_renderer_api_components_/index.html new file mode 100644 index 0000000000..4d9ec94635 --- /dev/null +++ b/v4.1.0/extensions/api/modules/_renderer_api_components_/index.html @@ -0,0 +1,1648 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/components" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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.tsx:7

    +
    +

    NotificationMessage#

    +

    Ƭ NotificationMessage: React.ReactNode | React.ReactNode[] | JsonApiErrorParsed

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx: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:16

    +
    +

    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:15

    +
    +

    TableSortCallback#

    +

    Ƭ TableSortCallback: function

    +

    Defined in src/renderer/components/table/table.tsx:18

    +

    Type declaration:

    +

    ▸ (data: D): string | number | (string | number)[]

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataD
    +
    +

    TableSortParams#

    +

    Ƭ TableSortParams: object

    +

    Defined in src/renderer/components/table/table.tsx:17

    +

    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 kubeDetailsUrlParam#

    +

    kubeDetailsUrlParam: PageParam‹string› = createPageParam({ + name: "kube-details", + isSystem: true, +})

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:16

    +
    +

    Const kubeSelectedUrlParam#

    +

    kubeSelectedUrlParam: PageParam‹string› = createPageParam({ + name: "kube-selected", + isSystem: true, + get defaultValue() { + return kubeDetailsUrlParam.get(); + } +})

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:21

    +
    +

    Const logTabStore#

    +

    logTabStore: LogTabStore‹› = new LogTabStore()

    +

    Defined in src/renderer/components/dock/log-tab.store.ts:119

    +
    +

    Const notificationsStore#

    +

    notificationsStore: NotificationsStore‹› = new NotificationsStore()

    +

    Defined in src/renderer/components/notifications/notifications.store.tsx:78

    +
    +

    Const orderByUrlParam#

    +

    orderByUrlParam: PageParam‹string› = createPageParam({ + name: "order", + isSystem: true, +})

    +

    Defined in src/renderer/components/table/table.tsx:49

    +
    +

    Const sortByUrlParam#

    +

    sortByUrlParam: PageParam‹string› = createPageParam({ + name: "sort", + isSystem: true, +})

    +

    Defined in src/renderer/components/table/table.tsx:44

    +
    +

    Const terminalStore#

    +

    terminalStore: TerminalStore‹› = new TerminalStore()

    +

    Defined in src/renderer/components/dock/terminal.store.ts:122

    +

    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:282

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsPartial‹MenuProps
    +

    Returns: Element‹›

    +
    +

    createTerminalTab#

    +

    createTerminalTab(tabParams: Partial‹ITerminalTab›): IDockTab

    +

    Defined in src/renderer/components/dock/terminal.store.ts:16

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    tabParamsPartial‹ITerminalTab›{}
    +

    Returns: IDockTab

    +
    +

    getDetailsUrl#

    +

    getDetailsUrl(details: string, resetSelected: boolean): string

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    detailsstring-
    resetSelectedbooleanfalse
    +

    Returns: string

    +
    +

    hideDetails#

    +

    hideDetails(): void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:35

    +

    Returns: void

    +
    +

    showDetails#

    +

    showDetails(details: string, resetSelected: boolean): void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:29

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    detailsstring""
    resetSelectedbooleantrue
    +

    Returns: void

    +
    +

    withTooltip#

    +

    withTooltipT›(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.1.0/extensions/api/modules/_renderer_api_k8s_api_/index.html b/v4.1.0/extensions/api/modules/_renderer_api_k8s_api_/index.html new file mode 100644 index 0000000000..c4be442594 --- /dev/null +++ b/v4.1.0/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -0,0 +1,1599 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/k8s-api" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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:64

    +
    +

    Const clusterRoleApi#

    +

    clusterRoleApi: KubeApiClusterRole‹›› = new KubeApi({ + objectConstructor: ClusterRole, +})

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:12

    +
    +

    Const clusterRoleBindingApi#

    +

    clusterRoleBindingApi: KubeApiClusterRoleBinding‹›› = new KubeApi({ + objectConstructor: ClusterRoleBinding, +})

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10

    +
    +

    Const configMapApi#

    +

    configMapApi: KubeApiConfigMap‹›› = new KubeApi({ + objectConstructor: ConfigMap, +})

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:26

    +
    +

    Const crdApi#

    +

    crdApi: KubeApiCustomResourceDefinition‹›› = new KubeApi({ + objectConstructor: CustomResourceDefinition, + checkPreferredVersion: true, +})

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:154

    +
    +

    Const cronJobApi#

    +

    cronJobApi: CronJobApi‹› = new CronJobApi({ + objectConstructor: CronJob, +})

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:131

    +
    +

    Const daemonSetApi#

    +

    daemonSetApi: KubeApiDaemonSet‹›› = 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:192

    +
    +

    Const endpointApi#

    +

    endpointApi: KubeApiEndpoint‹›› = new KubeApi({ + objectConstructor: Endpoint, +})

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:127

    +
    +

    Const eventApi#

    +

    eventApi: KubeApiKubeEvent‹›› = new KubeApi({ + objectConstructor: KubeEvent, +})

    +

    Defined in src/renderer/api/endpoints/events.api.ts:59

    +
    +

    Const hpaApi#

    +

    hpaApi: KubeApiHorizontalPodAutoscaler‹›› = 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: KubeApiJob‹›› = new KubeApi({ + objectConstructor: Job, +})

    +

    Defined in src/renderer/api/endpoints/job.api.ts:110

    +
    +

    Const limitRangeApi#

    +

    limitRangeApi: KubeApiLimitRange‹›› = new KubeApi({ + objectConstructor: LimitRange, +})

    +

    Defined in src/renderer/api/endpoints/limit-range.api.ts:55

    +
    +

    Const namespacesApi#

    +

    namespacesApi: KubeApiNamespace‹›› = new KubeApi({ + objectConstructor: Namespace, +})

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:25

    +
    +

    Const networkPolicyApi#

    +

    networkPolicyApi: KubeApiNetworkPolicy‹›› = 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: KubeApiPodDisruptionBudget‹›› = new KubeApi({ + objectConstructor: PodDisruptionBudget, +})

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47

    +
    +

    Const persistentVolumeApi#

    +

    persistentVolumeApi: KubeApiPersistentVolume‹›› = 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:490

    +
    +

    Const pvcApi#

    +

    pvcApi: PersistentVolumeClaimsApi‹› = new PersistentVolumeClaimsApi({ + objectConstructor: PersistentVolumeClaim, +})

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90

    +
    +

    Const replicaSetApi#

    +

    replicaSetApi: ReplicaSetApi‹› = new ReplicaSetApi({ + objectConstructor: ReplicaSet, +})

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:83

    +
    +

    Const resourceQuotaApi#

    +

    resourceQuotaApi: KubeApiResourceQuota‹›› = new KubeApi({ + objectConstructor: ResourceQuota, +})

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:66

    +
    +

    Const roleApi#

    +

    roleApi: KubeApiRole‹›› = new KubeApi({ + objectConstructor: Role, +})

    +

    Defined in src/renderer/api/endpoints/role.api.ts:21

    +
    +

    Const roleBindingApi#

    +

    roleBindingApi: KubeApiRoleBinding‹›› = new KubeApi({ + objectConstructor: RoleBinding, +})

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:34

    +
    +

    Const secretsApi#

    +

    secretsApi: KubeApiSecret‹›› = new KubeApi({ + objectConstructor: Secret, +})

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:48

    +
    +

    Const serviceAccountsApi#

    +

    serviceAccountsApi: KubeApiServiceAccount‹›› = new KubeApi({ + objectConstructor: ServiceAccount, +})

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:27

    +
    +

    Const serviceApi#

    +

    serviceApi: KubeApiService‹›› = 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: KubeApiStorageClass‹›› = new KubeApi({ + objectConstructor: StorageClass, +})

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:37

    +

    Functions#

    +

    forCluster#

    +

    forClusterT›(cluster: IKubeApiCluster, kubeClass: IKubeObjectConstructor‹T›): KubeApi‹T›

    +

    Defined in src/renderer/api/kube-api.ts:68

    +

    Type parameters:

    +

    T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    clusterIKubeApiCluster
    kubeClassIKubeObjectConstructor‹T›
    +

    Returns: KubeApi‹T›

    +
    +

    isAllowedResource#

    +

    isAllowedResource(resources: KubeResource | KubeResource[]): boolean

    +

    Defined in src/common/rbac.ts:44

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcesKubeResource | KubeResource[]
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/modules/_renderer_api_navigation_/index.html b/v4.1.0/extensions/api/modules/_renderer_api_navigation_/index.html new file mode 100644 index 0000000000..dba3f8af76 --- /dev/null +++ b/v4.1.0/extensions/api/modules/_renderer_api_navigation_/index.html @@ -0,0 +1,1136 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/navigation" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "renderer-api/navigation"#

    +

    Index#

    +

    Classes#

    + +

    Interfaces#

    + +

    Functions#

    + +

    Functions#

    +

    createPageParam#

    +

    createPageParamV›(init: PageParamInit‹V›): PageParam‹V›

    +

    Defined in src/extensions/renderer-api/navigation.ts:10

    +

    Type parameters:

    +

    V

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    initPageParamInit‹V›
    +

    Returns: PageParam‹V›

    +
    +

    getDetailsUrl#

    +

    getDetailsUrl(details: string, resetSelected: boolean): string

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    detailsstring-
    resetSelectedbooleanfalse
    +

    Returns: string

    +
    +

    hideDetails#

    +

    hideDetails(): void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:35

    +

    Returns: void

    +
    +

    isActiveRoute#

    +

    isActiveRoute(route: string | string[] | RouteProps): boolean

    +

    Defined in src/renderer/navigation/helpers.ts:25

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    routestring | string[] | RouteProps
    +

    Returns: boolean

    +
    + +

    navigate(location: LocationDescriptor): void

    +

    Defined in src/renderer/navigation/helpers.ts:7

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    locationLocationDescriptor
    +

    Returns: void

    +
    +

    showDetails#

    +

    showDetails(details: string, resetSelected: boolean): void

    +

    Defined in src/renderer/components/kube-object/kube-object-details.tsx:29

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    detailsstring""
    resetSelectedbooleantrue
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/api/modules/_renderer_api_theming_/index.html b/v4.1.0/extensions/api/modules/_renderer_api_theming_/index.html new file mode 100644 index 0000000000..4713ce1e6c --- /dev/null +++ b/v4.1.0/extensions/api/modules/_renderer_api_theming_/index.html @@ -0,0 +1,957 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/theming" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/capabilities/color-reference/index.html b/v4.1.0/extensions/capabilities/color-reference/index.html new file mode 100644 index 0000000000..b38c64ec52 --- /dev/null +++ b/v4.1.0/extensions/capabilities/color-reference/index.html @@ -0,0 +1,1301 @@ + + + + + + + + + + + + + + + + + + + + + + Color Reference - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    + +
    +
    + + + +
    +
    + + + +

    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.
    • +
    • --buttonLightBackground: light 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.1.0/extensions/capabilities/common-capabilities/index.html b/v4.1.0/extensions/capabilities/common-capabilities/index.html new file mode 100644 index 0000000000..2424255e01 --- /dev/null +++ b/v4.1.0/extensions/capabilities/common-capabilities/index.html @@ -0,0 +1,1413 @@ + + + + + + + + + + + + + + + + + + + + + + Common Capabilities - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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 = [
    +    {
    +      components: {
    +        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.1.0/extensions/capabilities/images/css-vars-in-devtools.png b/v4.1.0/extensions/capabilities/images/css-vars-in-devtools.png new file mode 100644 index 0000000000..a9df97e6bb Binary files /dev/null and b/v4.1.0/extensions/capabilities/images/css-vars-in-devtools.png differ diff --git a/v4.1.0/extensions/capabilities/images/theme-selector.png b/v4.1.0/extensions/capabilities/images/theme-selector.png new file mode 100644 index 0000000000..5c2eba3165 Binary files /dev/null and b/v4.1.0/extensions/capabilities/images/theme-selector.png differ diff --git a/v4.1.0/extensions/capabilities/index.html b/v4.1.0/extensions/capabilities/index.html new file mode 100644 index 0000000000..c455a064d9 --- /dev/null +++ b/v4.1.0/extensions/capabilities/index.html @@ -0,0 +1,875 @@ + + + + + + + + + + + + + + + + + + + + + + Index - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + +

    Index

    + + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/capabilities/styling/index.html b/v4.1.0/extensions/capabilities/styling/index.html new file mode 100644 index 0000000000..b26bf89206 --- /dev/null +++ b/v4.1.0/extensions/capabilities/styling/index.html @@ -0,0 +1,1225 @@ + + + + + + + + + + + + + + + + + + + + + + Styling - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/get-started/anatomy/index.html b/v4.1.0/extensions/get-started/anatomy/index.html new file mode 100644 index 0000000000..8b3092ef9a --- /dev/null +++ b/v4.1.0/extensions/get-started/anatomy/index.html @@ -0,0 +1,1111 @@ + + + + + + + + + + + + + + + + + + + + + + Extension Anatomy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/get-started/overview/index.html b/v4.1.0/extensions/get-started/overview/index.html new file mode 100644 index 0000000000..130f8a6e69 --- /dev/null +++ b/v4.1.0/extensions/get-started/overview/index.html @@ -0,0 +1,1018 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/get-started/wrapping-up/index.html b/v4.1.0/extensions/get-started/wrapping-up/index.html new file mode 100644 index 0000000000..6d0e5854de --- /dev/null +++ b/v4.1.0/extensions/get-started/wrapping-up/index.html @@ -0,0 +1,1030 @@ + + + + + + + + + + + + + + + + + + + + + + Wrapping Up - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/get-started/your-first-extension/index.html b/v4.1.0/extensions/get-started/your-first-extension/index.html new file mode 100644 index 0000000000..99e9c500fb --- /dev/null +++ b/v4.1.0/extensions/get-started/your-first-extension/index.html @@ -0,0 +1,1141 @@ + + + + + + + + + + + + + + + + + + + + + + Your First Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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. +
    3. In page.tsx, change the message from HelloWorld! to Hello Lens Extensions.
    4. +
    5. Rebuild the extension. If you used npm run dev, the extension will rebuild automatically.
    6. +
    7. Reload the Lens window.
    8. +
    9. Click on the Hello World page.
    10. +
    11. The updated message will appear.
    12. +
    +

    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.1.0/extensions/guides/anatomy/index.html b/v4.1.0/extensions/guides/anatomy/index.html new file mode 100644 index 0000000000..069db71999 --- /dev/null +++ b/v4.1.0/extensions/guides/anatomy/index.html @@ -0,0 +1,913 @@ + + + + + + + + + + + + + + + + + + + + + + Anatomy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Anatomy

    + +
    +

    WIP#

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/guides/components/index.html b/v4.1.0/extensions/guides/components/index.html new file mode 100644 index 0000000000..3be6694415 --- /dev/null +++ b/v4.1.0/extensions/guides/components/index.html @@ -0,0 +1,913 @@ + + + + + + + + + + + + + + + + + + + + + + Components - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Components

    + +
    +

    WIP#

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/guides/generator/index.html b/v4.1.0/extensions/guides/generator/index.html new file mode 100644 index 0000000000..aae1b832f1 --- /dev/null +++ b/v4.1.0/extensions/guides/generator/index.html @@ -0,0 +1,1076 @@ + + + + + + + + + + + + + + + + + + + + + + Generator - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Lens Extension Generator#

    +

    The Lens Extension Generator creates a directory with the necessary files for developing an extension.

    +

    Installing and Getting Started with the Generator#

    +

    To begin, install Yeoman and the Lens Extension Generator with the following command:

    +
    npm install -g yo generator-lens-ext
    +
    +

    Run the generator by entering the following command: yo lens-ext.

    +

    Answer the following questions:

    +
    # ? 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 :Users\<user>\.k8slens\extensions (windows)? Yes
    +
    +

    Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering:

    +
    cd my-first-lens-ext
    +npm start # start the webpack server in watch mode
    +
    +

    Open Lens and you will see a Hello World item in the left-side menu under Custom Resources:

    +

    Hello World

    +

    Developing the Extension#

    +

    Next, you'll try changing the way the new menu item appears in the UI. You'll change it from "Hello World" to "Hello Lens".

    +

    Open my-first-lens-ext/renderer.tsx and change the value of title from "Hello World" to "Hello Lens":

    +
    clusterPageMenus = [
    +    {
    +        target: { pageId: "hello" },
    +        title: "Hello Lens",
    +        components: {
    +            Icon: ExampleIcon,
    +        }
    +    }
    +]
    +
    +

    Reload Lens and you will see that the menu item text has changed to "Hello Lens." To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.

    +

    Hello World

    +

    Debugging the Extension#

    +

    To debug your extension, please see our instructions on Testing Extensions.

    +

    Next Steps#

    +

    To dive deeper, consider looking at Common Capabilities, Styling, or Extension Anatomy.

    +

    If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue. You can find the Lens contribution guidelines here.

    +

    The Generator source code is hosted at Github.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/guides/images/certificates-crd-list.png b/v4.1.0/extensions/guides/images/certificates-crd-list.png new file mode 100644 index 0000000000..19c9558f71 Binary files /dev/null and b/v4.1.0/extensions/guides/images/certificates-crd-list.png differ diff --git a/v4.1.0/extensions/guides/images/clusterpagemenus.png b/v4.1.0/extensions/guides/images/clusterpagemenus.png new file mode 100644 index 0000000000..3ed1c79e5b Binary files /dev/null and b/v4.1.0/extensions/guides/images/clusterpagemenus.png differ diff --git a/v4.1.0/extensions/guides/images/globalpagemenus.png b/v4.1.0/extensions/guides/images/globalpagemenus.png new file mode 100644 index 0000000000..e986cc32e9 Binary files /dev/null and b/v4.1.0/extensions/guides/images/globalpagemenus.png differ diff --git a/v4.1.0/extensions/guides/images/hello-lens.png b/v4.1.0/extensions/guides/images/hello-lens.png new file mode 100644 index 0000000000..5e2c0ac0a5 Binary files /dev/null and b/v4.1.0/extensions/guides/images/hello-lens.png differ diff --git a/v4.1.0/extensions/guides/images/hello-world.png b/v4.1.0/extensions/guides/images/hello-world.png new file mode 100644 index 0000000000..1a4a9c73a9 Binary files /dev/null and b/v4.1.0/extensions/guides/images/hello-world.png differ diff --git a/v4.1.0/extensions/guides/images/kubeobjectdetailitem.png b/v4.1.0/extensions/guides/images/kubeobjectdetailitem.png new file mode 100644 index 0000000000..e2d68f0c3b Binary files /dev/null and b/v4.1.0/extensions/guides/images/kubeobjectdetailitem.png differ diff --git a/v4.1.0/extensions/guides/images/kubeobjectdetailitemwithpods.png b/v4.1.0/extensions/guides/images/kubeobjectdetailitemwithpods.png new file mode 100644 index 0000000000..9a91f230f3 Binary files /dev/null and b/v4.1.0/extensions/guides/images/kubeobjectdetailitemwithpods.png differ diff --git a/v4.1.0/extensions/guides/images/kubeobjectmenuitem.png b/v4.1.0/extensions/guides/images/kubeobjectmenuitem.png new file mode 100644 index 0000000000..f9f91675de Binary files /dev/null and b/v4.1.0/extensions/guides/images/kubeobjectmenuitem.png differ diff --git a/v4.1.0/extensions/guides/images/kubeobjectmenuitemdetail.png b/v4.1.0/extensions/guides/images/kubeobjectmenuitemdetail.png new file mode 100644 index 0000000000..ab5f9ac0f0 Binary files /dev/null and b/v4.1.0/extensions/guides/images/kubeobjectmenuitemdetail.png differ diff --git a/v4.1.0/extensions/guides/index.html b/v4.1.0/extensions/guides/index.html new file mode 100644 index 0000000000..854dbbbba1 --- /dev/null +++ b/v4.1.0/extensions/guides/index.html @@ -0,0 +1,1088 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Extension Guides#

    +

    This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension.

    +

    Each guide or code sample includes the following:

    +
      +
    • Clearly commented source code.
    • +
    • Instructions for running the sample extension.
    • +
    • An image showing the sample extension's appearance and usage.
    • +
    • A listing of the Extension API being used.
    • +
    • An explanation of the concepts relevant to the Extension.
    • +
    +

    Guides#

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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.1.0/extensions/guides/kube-object-list-layout/index.html b/v4.1.0/extensions/guides/kube-object-list-layout/index.html new file mode 100644 index 0000000000..f522b861cd --- /dev/null +++ b/v4.1.0/extensions/guides/kube-object-list-layout/index.html @@ -0,0 +1,1174 @@ + + + + + + + + + + + + + + + + + + + + + + KubeObjectListLayout Sample - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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. +
    3. List Certificate Objects on the Cluster Page
    4. +
    5. Customize Details Panel
    6. +
    +

    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.1.0/extensions/guides/main-extension/index.html b/v4.1.0/extensions/guides/main-extension/index.html new file mode 100644 index 0000000000..36b5c5b30b --- /dev/null +++ b/v4.1.0/extensions/guides/main-extension/index.html @@ -0,0 +1,1103 @@ + + + + + + + + + + + + + + + + + + + + + + Main Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Main Extension#

    +

    The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process.

    +

    LensMainExtension Class#

    +

    onActivate() and onDeactivate() Methods#

    +

    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');
    +  }
    +}
    +
    +

    Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.

    +

    Disable extensions from the Lens Extensions page:

    +
      +
    1. Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions.)
    2. +
    3. Click Disable on the extension you want to disable.
    4. +
    +

    The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt.

    +

    The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active 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");
    +  }
    +}
    +
    +

    For more details on accessing Lens state data, please see the Stores guide.

    +

    appMenus#

    +

    The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an 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 that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows:

    +
      +
    • parentId is the name of the menu where your new menu item will be listed. Valid values include: "file", "edit", "view", and "help". "lens" is valid on Mac only.
    • +
    • label is the name of your menu item.
    • +
    • click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending it.
    • +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/guides/renderer-extension/index.html b/v4.1.0/extensions/guides/renderer-extension/index.html new file mode 100644 index 0000000000..c61bb64200 --- /dev/null +++ b/v4.1.0/extensions/guides/renderer-extension/index.html @@ -0,0 +1,1892 @@ + + + + + + + + + + + + + + + + + + + + + + Renderer Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    Renderer Extension#

    +

    The Renderer Extension API is the interface to Lens's renderer process. Lens runs in both the main and renderer processes. The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, and run custom code in Lens's renderer process.

    +

    The custom Lens UI elements that you can add include:

    + +

    All UI elements are based on React components.

    +

    LensRendererExtension Class#

    +

    onActivate() and onDeactivate() Methods#

    +

    To create a renderer extension, 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');
    +  }
    +}
    +
    +

    Two methods enable you to run custom code: onActivate() and onDeactivate(). Enabling your extension calls onActivate() and disabling your extension calls onDeactivate(). You can initiate custom code by implementing onActivate(). Implementing onDeactivate() gives you the opportunity to clean up after your extension.

    +
    +

    Info

    +

    Disable extensions from the Lens Extensions page:

    +
      +
    1. Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions.)
    2. +
    3. Click Disable on the extension you want to disable.
    4. +
    +
    +

    The example above logs messages when the extension is enabled and disabled.

    +

    clusterPages#

    +

    Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with clusterStore.

    +

    Add a cluster page definition to a LensRendererExtension subclass with the following example:

    +
    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}/>,
    +      }
    +    }
    +  ];
    +}
    +
    +

    clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows:

    +
      +
    • id is a string that identifies the page.
    • +
    • components matches the PageComponents interface for which there is one field, Page.
    • +
    • Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.
    • +
    +

    ExamplePage in the example above 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 the extension property. This allows the ExampleExtension object to be passed in the cluster page definition in the React style. This way, ExamplePage can access all ExampleExtension subclass data.

    +

    The above example shows how to create a cluster page, but not how to make that page available to the Lens user. Use clusterPageMenus, covered in the next section, to add cluster pages to the Lens UI.

    +

    clusterPageMenus#

    +

    clusterPageMenus allows you to add cluster page menu items to the secondary left nav.

    +

    By expanding on the above example, you can add a cluster page menu item 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,
    +      }
    +    },
    +  ];
    +}
    +
    +

    clusterPageMenus is an array of objects that satisfy the ClusterPageMenuRegistration interface. This element defines how the cluster page menu item will appear and what it will do when you click it. The properties of the clusterPageMenus array objects are defined as follows:

    +
      +
    • target links to the relevant cluster page using pageId.
    • +
    • pageId takes the value of the relevant cluster page's id property.
    • +
    • title sets the name of the cluster page menu item that will appear in the left side menu.
    • +
    • components is used to set an icon that appears to the left of the title text in the left side menu.
    • +
    +

    The above example creates a menu item that reads Hello World. When users click Hello World, the cluster dashboard will show the contents of Example Page.

    +

    This example requires the definition of another React-based component, ExampleIcon, which has been added to page.tsx, as follows:

    +
    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>
    +    )
    +  }
    +}
    +
    +

    Lens includes various built-in components available for extension developers to use. One of these is the Component.Icon, introduced in ExampleIcon, which you can use to access any of the icons available at Material Design. The properties that Component.Icon uses are defined as follows:

    +
      +
    • material takes the name of the icon you want to use.
    • +
    • tooltip sets the text you want to appear when a user hovers over the icon.
    • +
    +

    clusterPageMenus can also be used to define sub menu items, so that you can create groups of cluster pages. The following example groups two sub menu items under one parent menu item:

    +
    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 definitions are straightforward. +The three cluster page menu objects include one parent menu item and two sub menu items. +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.

    +

    This is what the example will look like, including how the menu item will appear in the secondary left nav:

    +

    globalPages#

    +

    Global pages are independent of the cluster dashboard and can fill the entire Lens UI. Their primary use is to display information and provide functionality across clusters, including customized data and functionality unique to your extension.

    +

    Typically, you would use a global page menu located in the left nav to trigger a global page. You can also trigger a global page with a custom app menu selection from a Main Extension or a custom status bar item. Unlike cluster pages, users can trigger global pages even when there is no active cluster.

    +

    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}/>,
    +      }
    +    }
    +  ];
    +}
    +
    +

    globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows:

    +
      +
    • id is a string that identifies the page.
    • +
    • components matches the PageComponents interface for which there is one field, Page.
    • +
    • Page is of type React.ComponentType<any>. It offers flexibility in defining the appearance and behavior of your page.
    • +
    +

    HelpPage in the example above 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 the extension property. This allows the HelpExtension object to be passed in the global page definition in the React-style. This way, HelpPage can access all HelpExtension subclass data.

    +

    This example code shows how to create a global page, but not how to make that page available to the Lens user. Global pages can be made available in the following ways:

    +
      +
    • To add global pages to the top menu bar, see appMenus in the Main Extension guide.
    • +
    • To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems.
    • +
    • To add global pages to the left side menu, see globalPageMenus.
    • +
    +

    globalPageMenus#

    +

    globalPageMenus allows you to add global page menu items to the left nav.

    +

    By expanding on the above example, you can add a global page menu item 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,
    +      }
    +    },
    +  ];
    +}
    +
    +

    globalPageMenus is an array of objects that satisfy the PageMenuRegistration interface. This element defines how the global page menu item will appear and what it will do when you click it. The properties of the globalPageMenus array objects are defined as follows:

    +
      +
    • target links to the relevant global page using pageId.
    • +
    • pageId takes the value of the relevant global page's id property.
    • +
    • title sets the name of the global page menu item that will display as a tooltip in the left nav.
    • +
    • components is used to set an icon that appears in the left nav.
    • +
    +

    The above example creates a "Help" icon menu item. When users click the icon, the Lens UI will display the contents of ExamplePage.

    +

    This example requires the definition of another React-based component, HelpIcon. Update page.tsx from the example above with the HelpIcon definition, as follows:

    +
    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>
    +    )
    +  }
    +}
    +
    +

    Lens includes various built-in components available for extension developers to use. One of these is the Component.Icon, introduced in HelpIcon, which you can use to access any of the icons available at Material Design. The property that Component.Icon uses is defined as follows:

    +
      +
    • material takes the name of the icon you want to use.
    • +
    +

    This is what the example will look like, including how the menu item will appear in the left nav:

    +

    globalPageMenus

    +

    clusterFeatures#

    +

    Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. +They can be installed and uninstalled by the Lens user from the cluster Settings page.

    +
    +

    Info

    +

    To access the cluster Settings page, right-click the relevant cluster in the left side menu and click Settings.

    +
    +

    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 properties of the clusterFeatures array objects are defined as follows:

    +
      +
    • title and components.Description provide content that appears on the cluster settings page, in the Features section.
    • +
    • feature specifies an instance which extends the abstract class ClusterFeature.Feature, and specifically implements 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 four methods listed above are defined as follows:

    +
      +
    • +

      The install() method installs Kubernetes resources using the applyResources() method, or by directly accessing the Kubernetes API. +This method is typically called when a user indicates that they want to install the feature (i.e., by clicking Install for the feature in the cluster settings page).

      +
    • +
    • +

      The upgrade() method upgrades the Kubernetes resources already installed, if they are relevant to the feature. +This method is typically called when a user indicates that they want to upgrade the feature (i.e., by clicking Upgrade for the feature in the cluster settings page).

      +
    • +
    • +

      The uninstall() method uninstalls Kubernetes resources using the Kubernetes API. +This method is typically called when a user indicates that they want to uninstall the feature (i.e., by clicking Uninstall for the feature in the cluster settings page).

      +
    • +
    • +

      The updateStatus() method provides the current status information in the status field of the ClusterFeature.Feature parent class. +Lens periodically calls this method to determine details about the feature's current status. +The implementation of this method should uninstall Kubernetes resources using the Kubernetes api (K8sApi) +Consider using the following properties with updateStatus():

      +
        +
      • +

        status.currentVersion and status.latestVersion may be displayed by Lens in the feature's description.

        +
      • +
      • +

        status.installed should be set to true if the feature is installed, and false otherwise.

        +
      • +
      • +

        status.canUpgrade is set according to a rule meant to determine whether the feature can be upgraded. This rule can involve status.currentVersion and status.latestVersion, if desired.

        +
      • +
      +
    • +
    +

    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 invoking the helper applyResources() method. +applyResources() tries to apply all resources read from all files found in the folder path provided. +In this case the folder path is the ../resources subfolder relative to the 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 example above implements the four methods as follows:

    +
      +
    • +

      It implements upgrade() by invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps.

      +
    • +
    • +

      It implements uninstall() by utilizing the Kubernetes API which Lens provides to delete the example-pod applied by the install() method.

      +
    • +
    • +

      It implements updateStatus() by using the Kubernetes API which Lens provides to determine whether the example-pod is installed, what version is associated with it, and whether it can be upgraded. The implementation determines what the status is for a specific cluster feature.

      +
    • +
    +

    appPreferences#

    +

    The Lens Preferences page is a built-in global page. You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options.

    +

    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/>
    +      }
    +    }
    +  ];
    +}
    +
    +

    appPreferences is an array of objects that satisfies the AppPreferenceRegistration interface. The properties of the appPreferences array objects are defined as follows:

    +
      +
    • title sets the heading text displayed on the Preferences page.
    • +
    • components specifies two React.Component objects that define the interface for the preference.
        +
      • Input specifies an interactive input element for the preference.
      • +
      • Hint provides descriptive information for the preference, shown below the Input element.
      • +
      +
    • +
    +
    +

    Note

    +

    Note that the input and the hint can be comprised of more sophisticated elements, according to the needs of the extension.

    +
    +

    ExamplePreferenceInput expects its React props to be set to an ExamplePreferenceProps instance. This is how ExampleRendererExtension handles the state of the preference input. +ExampleRendererExtension has a preference field, which you will add to ExamplePreferenceInput.

    +

    In this example ExamplePreferenceInput, ExamplePreferenceHint, and ExamplePreferenceProps are defined in ./src/example-preference.tsx as follows:

    +
    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 using the following properties:

    +
      +
    • label sets the text that displays next to the checkbox.
    • +
    • value is initially set to preference.enabled.
    • +
    • onChange is a function that responds when the state of the checkbox changes.
    • +
    +

    ExamplePreferenceInput is defined with the ExamplePreferenceProps React props. This is an object with the single enabled property. It is used to indicate the state of the preference, and it is bound to the checkbox state in onChange.

    +

    ExamplePreferenceHint is a simple text span.

    +

    The above example introduces the decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management. 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. We recommend that extensions rely on it, as well. +Alternatively, you can use React's state management, though mobx is typically simpler to use.

    +

    Note that you can manage an extension's state data using an ExtensionStore object, which conveniently handles persistence and synchronization. To simplify this guide, the example above defines a preference field in the ExampleRendererExtension class definition to hold the extension's state. However, we recommend that you manage your extension's state data using ExtensionStore.

    +

    statusBarItems#

    +

    The status bar is the blue strip along the bottom of the Lens UI. statusBarItems are React.ReactNode types. They can be used to display status information, or act as links to global pages as well as external pages.

    +

    The following example adds a statusBarItems definition and a globalPages definition to a LensRendererExtension subclass. It 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 = [
    +    {
    +      components: {
    +        Item: (
    +          <div
    +            className="flex align-center gaps"
    +            onClick={() => this.navigate("help")}
    +          >
    +            <HelpIcon />
    +            My Status Bar Item
    +          </div>
    +        )
    +      },
    +    },
    +  ];
    +}
    +
    +

    The properties of the statusBarItems array objects are defined as follows:

    +
      +
    • Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide.
    • +
    • onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages.
    • +
    +

    kubeObjectMenuItems#

    +

    An extension can add custom menu items (kubeObjectMenuItems) for specific Kubernetes resource kinds and apiVersions. +kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard:

    +

    List

    +

    They also appear on the title bar of the details page for specific resources:

    +

    Details

    +

    The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action:

    +
    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} />
    +      }
    +    }
    +  ];
    +}
    +
    +

    kubeObjectMenuItems is an array of objects matching the KubeObjectMenuRegistration interface. The example above adds a menu item for namespaces in the cluster dashboard. The properties of the kubeObjectMenuItems array objects are defined as follows:

    +
      +
    • kind specifies the Kubernetes resource type the menu item will apply to.
    • +
    • apiVersion specifies the Kubernetes API version number to use with the resource type.
    • +
    • components defines the menu item's appearance and behavior.
    • +
    • MenuItem 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 which defines the menu item's appearance and its behavior when activated via the onClick property. In the example, getPods() opens a terminal tab and runs kubectl to get a list of pods running in the current namespace.

    +

    The name of the namespace is retrieved from props passed into NamespaceMenuItem(). namespace is the props.object, which is of type K8sApi.Namespace. K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName(). Thus, kubeObjectMenuItems afford convenient access to the specific resource selected by the user.

    +

    kubeObjectDetailItems#

    +

    An extension can add custom details (kubeObjectDetailItems) for specified Kubernetes resource kinds and apiVersions. +These custom details appear on the details page for a specific resource, such as a Namespace as shown here:

    +

    Details

    +

    The following example shows how to use kubeObjectDetailItems 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} />
    +      }
    +    }
    +  ];
    +}
    +
    +

    kubeObjectDetailItems is an array of objects matching the KubeObjectDetailRegistration interface. This example above adds a detail item for namespaces in the cluster dashboard. The properties of the kubeObjectDetailItems array objects are defined as follows:

    +
      +
    • kind specifies the Kubernetes resource type the detail item will apply to.
    • +
    • apiVersion specifies the Kubernetes API version number to use with the resource type.
    • +
    • components defines the detail item's appearance and behavior.
    • +
    • Details 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. +You can query this object for many details about the current namespace. +In the example above, componentDidMount() gets the namespace's name using the K8sApi.Namespace getName() method. +Use the namespace's name to limit the list of pods only to those in the relevant namespace. +To get this list of pods, this example uses the Kubernetes pods API K8sApi.podsApi.list() method. +The K8sApi.podsApi is automatically configured for the active cluster.

    +

    Note that K8sApi.podsApi.list() is an asynchronous method. +Getting the pods list should occur prior to 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 updates. +This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer.

    +

    Finally, the NamespaceDetailsItem renders 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

    +

    Obtain the name, age, and status for each pod using the K8sApi.Pod methods. Construct the table using the Component.Table and related elements.

    +

    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.1.0/extensions/guides/stores/index.html b/v4.1.0/extensions/guides/stores/index.html new file mode 100644 index 0000000000..e6e5d72944 --- /dev/null +++ b/v4.1.0/extensions/guides/stores/index.html @@ -0,0 +1,1112 @@ + + + + + + + + + + + + + + + + + + + + + + Stores - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Stores#

    +

    Stores are components that persist and synchronize state data. Lens uses a number of stores to maintain various kinds of state information, including:

    +
      +
    • The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active.
    • +
    • The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace.
    • +
    • The ExtensionStore manages custom extension state data.
    • +
    +

    This guide focuses on the ExtensionStore.

    +

    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 or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted.

    +

    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, our example defines the extension's data model using the simple ExamplePreferencesModel type. This has a single field, enabled, which represents the preference's state. ExamplePreferencesStore extends Store.ExtensionStore, which is based on the ExamplePreferencesModel. The enabled field is added to the ExamplePreferencesStore class to hold the "live" or current state of the preference. Note the use of the observable decorator on the enabled field. The appPreferences guide example uses MobX for the UI state management, ensuring the checkbox updates when it's activated by the user.

    +

    Next, our example implements the constructor and two abstract methods. The constructor specifies the name of the store ("example-preferences-store") and the default (initial) value for the preference state (enabled: false). Lens internals call the fromStore() method when the store loads. It gives the extension the opportunity to retrieve the stored state data values based on the defined data model. 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(). It 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 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 loads with examplePreferencesStore.loadExtension(this), which is conveniently called from the onActivate() method of ExampleMainExtension. +Similarly, examplePreferencesStore must load 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. There is no longer the need for the preference field in the ExampleRendererExtension class because 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 that 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.1.0/extensions/guides/working-with-mobx/index.html b/v4.1.0/extensions/guides/working-with-mobx/index.html new file mode 100644 index 0000000000..74d794a101 --- /dev/null +++ b/v4.1.0/extensions/guides/working-with-mobx/index.html @@ -0,0 +1,1025 @@ + + + + + + + + + + + + + + + + + + + + + + Working with MobX - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Working with MobX#

    +

    Introduction#

    +

    Lens uses MobX on top of React's state management system. +The result is a more declarative state management style, rather than React's native setState mechanism.

    +

    You can review how React handles state management here.

    +

    The following is a quick overview:

    +
      +
    • React.Component is generic with respect to both props and state (which default to the empty object type).
    • +
    • props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component.
    • +
    • state is a component's internal state, and can be read by accessing the super-class field state.
    • +
    • state must be updated using the setState parent method which merges the new data with the old state.
    • +
    • React does 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 system. The three main concepts are:

    +
      +
    • observable is a marker for data stored in the component's state.
    • +
    • action is a function that modifies any observable data.
    • +
    • computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count.
    • +
    +

    Further reading is available on the MobX website.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/extensions/index.html b/v4.1.0/extensions/index.html new file mode 100644 index 0000000000..51a7a7a137 --- /dev/null +++ b/v4.1.0/extensions/index.html @@ -0,0 +1,1075 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/testing-and-publishing/bundling/index.html b/v4.1.0/extensions/testing-and-publishing/bundling/index.html new file mode 100644 index 0000000000..fbc409d2ad --- /dev/null +++ b/v4.1.0/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.1.0/extensions/testing-and-publishing/publishing/index.html b/v4.1.0/extensions/testing-and-publishing/publishing/index.html new file mode 100644 index 0000000000..b72ca50040 --- /dev/null +++ b/v4.1.0/extensions/testing-and-publishing/publishing/index.html @@ -0,0 +1,1074 @@ + + + + + + + + + + + + + + + + + + + + + + Publishing Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/testing-and-publishing/testing/index.html b/v4.1.0/extensions/testing-and-publishing/testing/index.html new file mode 100644 index 0000000000..a1b804ed8d --- /dev/null +++ b/v4.1.0/extensions/testing-and-publishing/testing/index.html @@ -0,0 +1,1127 @@ + + + + + + + + + + + + + + + + + + + + + + Testing Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/extensions/typedoc-readme.md.tpl b/v4.1.0/extensions/typedoc-readme.md.tpl new file mode 100644 index 0000000000..6e23d197d5 --- /dev/null +++ b/v4.1.0/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.1.0/extensions/usage/images/extensions.png b/v4.1.0/extensions/usage/images/extensions.png new file mode 100644 index 0000000000..5deb8e4bd2 Binary files /dev/null and b/v4.1.0/extensions/usage/images/extensions.png differ diff --git a/v4.1.0/extensions/usage/index.html b/v4.1.0/extensions/usage/index.html new file mode 100644 index 0000000000..ab2f800f18 --- /dev/null +++ b/v4.1.0/extensions/usage/index.html @@ -0,0 +1,1032 @@ + + + + + + + + + + + + + + + + + + + + + + Using Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/faq/index.html b/v4.1.0/faq/index.html new file mode 100644 index 0000000000..1417b4fe70 --- /dev/null +++ b/v4.1.0/faq/index.html @@ -0,0 +1,1147 @@ + + + + + + + + + + + + + + + + + + + + + + FAQ - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + + + +
    +
    + + + +

    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

    +

    Why Lens window rendering is broken?#

    +

    MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display. Same thing can happen with any of Electron applications or Chrome itself.

    +

    fuzzy lines

    +

    As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app.

    +

    First, open .bash_profile file from your terminal

    +
    open -a TextEdit.app ~/.bash_profile
    +
    +

    Then, add this line

    +
    export LENS_DISABLE_GPU=true
    +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/getting-started/images/color-theme.png b/v4.1.0/getting-started/images/color-theme.png new file mode 100644 index 0000000000..5e4f144560 Binary files /dev/null and b/v4.1.0/getting-started/images/color-theme.png differ diff --git a/v4.1.0/getting-started/images/disabled-telemetry-usage-tracking.png b/v4.1.0/getting-started/images/disabled-telemetry-usage-tracking.png new file mode 100644 index 0000000000..809a96056a Binary files /dev/null and b/v4.1.0/getting-started/images/disabled-telemetry-usage-tracking.png differ diff --git a/v4.1.0/getting-started/images/snap-store.png b/v4.1.0/getting-started/images/snap-store.png new file mode 100644 index 0000000000..5e652132c3 Binary files /dev/null and b/v4.1.0/getting-started/images/snap-store.png differ diff --git a/v4.1.0/getting-started/index.html b/v4.1.0/getting-started/index.html new file mode 100644 index 0000000000..d4794c8a3e --- /dev/null +++ b/v4.1.0/getting-started/index.html @@ -0,0 +1,1116 @@ + + + + + + + + + + + + + + + + + + + + + + Getting Started - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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. +
    3. Open the browser's download list and locate the downloaded archive.
    4. +
    5. Select the 'magnifying glass' icon to open the archive in Finder.
    6. +
    7. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad.
    8. +
    9. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options, Keep in Dock.
    10. +
    +

    Windows#

    +
      +
    1. Download the Lens installer for Windows.
    2. +
    3. Once it is downloaded, run the installer Lens-Setup-{version}.exe. This will only take a minute.
    4. +
    5. By default, Lens is installed under C:\users\{username}\AppData\Local\Programs\Lens.
    6. +
    +

    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.1.0/getting-started/introductory-videos/index.html b/v4.1.0/getting-started/introductory-videos/index.html new file mode 100644 index 0000000000..09f1c28af6 --- /dev/null +++ b/v4.1.0/getting-started/introductory-videos/index.html @@ -0,0 +1,917 @@ + + + + + + + + + + + + + + + + + + + + + + Introductory Videos - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/getting-started/preferences/index.html b/v4.1.0/getting-started/preferences/index.html new file mode 100644 index 0000000000..719c85e774 --- /dev/null +++ b/v4.1.0/getting-started/preferences/index.html @@ -0,0 +1,1045 @@ + + + + + + + + + + + + + + + + + + + + + + Preferences - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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. +
    3. Select your preferred theme from the Color Theme dropdown. +Color Theme
    4. +
    +

    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. +
    3. Scroll down to Telemetry & Usage Tracking
    4. +
    5. Uncheck Allow Telemetry & Usage Tracking.
    6. +
    +

    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.1.0/helm/images/helm-charts.png b/v4.1.0/helm/images/helm-charts.png new file mode 100644 index 0000000000..93548fca9e Binary files /dev/null and b/v4.1.0/helm/images/helm-charts.png differ diff --git a/v4.1.0/helm/index.html b/v4.1.0/helm/index.html new file mode 100644 index 0000000000..61b1dce7b8 --- /dev/null +++ b/v4.1.0/helm/index.html @@ -0,0 +1,1039 @@ + + + + + + + + + + + + + + + + + + + + + + Using Helm Charts - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/img/favicon.ico b/v4.1.0/img/favicon.ico new file mode 100644 index 0000000000..19b2de71d1 Binary files /dev/null and b/v4.1.0/img/favicon.ico differ diff --git a/v4.1.0/img/lens-intro-video-screenshot.png b/v4.1.0/img/lens-intro-video-screenshot.png new file mode 100644 index 0000000000..2c5467b3f0 Binary files /dev/null and b/v4.1.0/img/lens-intro-video-screenshot.png differ diff --git a/v4.1.0/img/lens-logo-icon.svg b/v4.1.0/img/lens-logo-icon.svg new file mode 100644 index 0000000000..ede39244e5 --- /dev/null +++ b/v4.1.0/img/lens-logo-icon.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + diff --git a/v4.1.0/img/play.svg b/v4.1.0/img/play.svg new file mode 100644 index 0000000000..a94d6e88ab --- /dev/null +++ b/v4.1.0/img/play.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v4.1.0/index.html b/v4.1.0/index.html new file mode 100644 index 0000000000..e7a2c4ce2a --- /dev/null +++ b/v4.1.0/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.1.0/search/search_index.json b/v4.1.0/search/search_index.json new file mode 100644 index 0000000000..87d1be0d3b --- /dev/null +++ b/v4.1.0/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 Developing on Windows # On Windows we only support Git Bash (or similar shell) for running commands. Github Workflow # We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow Code Testing # All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing License # By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"Development"},{"location":"contributing/development/#development","text":"Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.","title":"Development"},{"location":"contributing/development/#recommended-reading","text":"TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs)","title":"Recommended Reading:"},{"location":"contributing/development/#local-development-environment","text":"Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts","title":"Local Development Environment"},{"location":"contributing/development/#developing-on-windows","text":"On Windows we only support Git Bash (or similar shell) for running commands.","title":"Developing on Windows"},{"location":"contributing/development/#github-workflow","text":"We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow","title":"Github Workflow"},{"location":"contributing/development/#code-testing","text":"All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing","title":"Code Testing"},{"location":"contributing/development/#license","text":"By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"License"},{"location":"contributing/documentation/","text":"Documentation # We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source . Finding Documentation Issues to Work On # You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request. Requirements for Documentation Pull Requests # When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. Testing Documentation Site Locally # Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Documentation"},{"location":"contributing/documentation/#documentation","text":"We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source .","title":"Documentation"},{"location":"contributing/documentation/#finding-documentation-issues-to-work-on","text":"You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request.","title":"Finding Documentation Issues to Work On"},{"location":"contributing/documentation/#requirements-for-documentation-pull-requests","text":"When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.","title":"Requirements for Documentation Pull Requests"},{"location":"contributing/documentation/#testing-documentation-site-locally","text":"Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Testing Documentation Site Locally"},{"location":"contributing/github_workflow/","text":"Github Workflow # Fork The Project Adding the Forked Remote Create & Rebase Your Feature Branch Commit & Push Open a Pull Request Get a code review Squash commits Push Your Final Changes This guide assumes you have already cloned the upstream repo to your system via git clone. Fork The Project # Go to http://github.com/lensapp/lens On the top, right-hand side, click on \"fork\" and select your username for the fork destination. Adding the Forked Remote # export GITHUB_USER={ your github's username } cd $WORKDIR/lens git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git # Prevent push to Upstream git remote set-url --push origin no_push # Set your fork remote as a default push target git push --set-upstream $GITHUB_USER master Your remotes should look something like this: \u279c git remote -v origin https://github.com/lensapp/lens (fetch) origin no_push (push) my_fork git@github.com:{ github_username }/lens.git (fetch) my_fork git@github.com:{ github_username }/lens.git (push) Create & Rebase Your Feature Branch # Create a feature branch: git branch -b my_feature_branch Rebase your branch: git fetch origin git rebase origin/master Current branch my_feature_branch is up to date. Please don't use git pull instead of the above fetch / rebase . git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. Commit & Push # Commit and sign your changes: git commit -m \"my commit title\" --signoff You can go back and edit/build/test some more, then commit --amend in a few cycles. When ready, push your changes to your fork's repository: git push --set-upstream my_fork my_feature_branch Open a Pull Request # See Github Docs . Get a code review # Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. Commit changes made in response to review comments should be added to the same branch on your fork. Very small PRs are easy to review. Very large PRs are very difficult to review. Squashing Commits # Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. To do that, it's best to perform an interactive rebase : Example If you PR has 3 commits, count backwards from your last commit using HEAD~3 : git rebase -i HEAD~3 Output would be similar to this: pick f7f3f6d Changed some code pick 310154e fixed some typos pick a5f4a0d made some review changes # Rebase 710f0f8..a5f4a0d onto 710f0f8 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like \"squash\", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # b, break = stop here (continue rebase later with 'git rebase --continue') # d, drop = remove commit # l, label
    ); }) Defined in src/renderer/components/layout/tab-layout.tsx:27 Const kubeDetailsUrlParam # \u2022 kubeDetailsUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-details\", isSystem: true, }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:16 Const kubeSelectedUrlParam # \u2022 kubeSelectedUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-selected\", isSystem: true, get defaultValue() { return kubeDetailsUrlParam.get(); } }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:21 Const logTabStore # \u2022 logTabStore : LogTabStore\u2039\u203a = new LogTabStore() Defined in src/renderer/components/dock/log-tab.store.ts:119 Const notificationsStore # \u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.tsx:78 Const orderByUrlParam # \u2022 orderByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"order\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:49 Const sortByUrlParam # \u2022 sortByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"sort\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:44 Const terminalStore # \u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:122 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:282 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a createTerminalTab # \u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:16 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab getDetailsUrl # \u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string hideDetails # \u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void showDetails # \u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void 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 CommandOverlay ConfirmDialog CubeSpinner Dialog Drawer DrawerItem DrawerParamToggler DrawerTitle Icon Input KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress Menu MenuActions MenuItem NamespaceSelect Notifications NotificationsStore PageLayout PodDetailsList Radio RadioGroup Select Slider Spinner StatusBrick Stepper Tab Table TableCell TableHead TableRow Tabs Tooltip Wizard WizardLayout WizardStep","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 WizardProps WizardStepProps","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 kubeDetailsUrlParam kubeSelectedUrlParam logTabStore notificationsStore orderByUrlParam sortByUrlParam terminalStore","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#functions","text":"DrawerItemLabels SubMenu createTerminalTab getDetailsUrl hideDetails showDetails 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.tsx: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.tsx: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:16","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:15","title":"TableSortBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortcallback","text":"\u01ac TableSortCallback : function Defined in src/renderer/components/table/table.tsx:18","title":"TableSortCallback"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortparams","text":"\u01ac TableSortParams : object Defined in src/renderer/components/table/table.tsx:17","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-kubedetailsurlparam","text":"\u2022 kubeDetailsUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-details\", isSystem: true, }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:16","title":"Const kubeDetailsUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-kubeselectedurlparam","text":"\u2022 kubeSelectedUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"kube-selected\", isSystem: true, get defaultValue() { return kubeDetailsUrlParam.get(); } }) Defined in src/renderer/components/kube-object/kube-object-details.tsx:21","title":"Const kubeSelectedUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-logtabstore","text":"\u2022 logTabStore : LogTabStore\u2039\u203a = new LogTabStore() Defined in src/renderer/components/dock/log-tab.store.ts:119","title":"Const logTabStore"},{"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.tsx:78","title":"Const notificationsStore"},{"location":"extensions/api/modules/_renderer_api_components_/#const-orderbyurlparam","text":"\u2022 orderByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"order\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:49","title":"Const orderByUrlParam"},{"location":"extensions/api/modules/_renderer_api_components_/#const-sortbyurlparam","text":"\u2022 sortByUrlParam : PageParam \u2039string\u203a = createPageParam({ name: \"sort\", isSystem: true, }) Defined in src/renderer/components/table/table.tsx:44","title":"Const sortByUrlParam"},{"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:122","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:282 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a","title":"SubMenu"},{"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:16 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab","title":"createTerminalTab"},{"location":"extensions/api/modules/_renderer_api_components_/#getdetailsurl","text":"\u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string","title":"getDetailsUrl"},{"location":"extensions/api/modules/_renderer_api_components_/#hidedetails","text":"\u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void","title":"hideDetails"},{"location":"extensions/api/modules/_renderer_api_components_/#showdetails","text":"\u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details string \"\" resetSelected boolean true Returns: void","title":"showDetails"},{"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 LimitRange LimitRangesStore 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 limitRangeApi 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:64 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 : CronJobApi\u2039\u203a = new CronJobApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:131 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:192 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 limitRangeApi # \u2022 limitRangeApi : KubeApi \u2039 LimitRange \u2039\u203a\u203a = new KubeApi({ objectConstructor: LimitRange, }) Defined in src/renderer/api/endpoints/limit-range.api.ts:55 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:490 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 : ReplicaSetApi\u2039\u203a = new ReplicaSetApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:83 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:68 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:44 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 LimitRange LimitRangesStore 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 limitRangeApi 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:64","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 : CronJobApi\u2039\u203a = new CronJobApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:131","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:192","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-limitrangeapi","text":"\u2022 limitRangeApi : KubeApi \u2039 LimitRange \u2039\u203a\u203a = new KubeApi({ objectConstructor: LimitRange, }) Defined in src/renderer/api/endpoints/limit-range.api.ts:55","title":"Const limitRangeApi"},{"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:490","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 : ReplicaSetApi\u2039\u203a = new ReplicaSetApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:83","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:68 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:44 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"isAllowedResource"},{"location":"extensions/api/modules/_renderer_api_navigation_/","text":"Module: \"renderer-api/navigation\" # Index # Classes # PageParam Interfaces # IURLParams PageParamInit Functions # createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails Functions # createPageParam # \u25b8 createPageParam \u2039 V \u203a( init : PageParamInit \u2039V\u203a): PageParam \u2039V\u203a Defined in src/extensions/renderer-api/navigation.ts:10 Type parameters: \u25aa V Parameters: Name Type init PageParamInit \u2039V\u203a Returns: PageParam \u2039V\u203a getDetailsUrl # \u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string hideDetails # \u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void isActiveRoute # \u25b8 isActiveRoute ( route : string | string[] | RouteProps): boolean Defined in src/renderer/navigation/helpers.ts:25 Parameters: Name Type route string | string[] | RouteProps Returns: boolean navigate # \u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation/helpers.ts:7 Parameters: Name Type location LocationDescriptor Returns: void showDetails # \u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details 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_/#classes","text":"PageParam","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_navigation_/#interfaces","text":"IURLParams PageParamInit","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions","text":"createPageParam getDetailsUrl hideDetails isActiveRoute navigate showDetails","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#createpageparam","text":"\u25b8 createPageParam \u2039 V \u203a( init : PageParamInit \u2039V\u203a): PageParam \u2039V\u203a Defined in src/extensions/renderer-api/navigation.ts:10 Type parameters: \u25aa V Parameters: Name Type init PageParamInit \u2039V\u203a Returns: PageParam \u2039V\u203a","title":"createPageParam"},{"location":"extensions/api/modules/_renderer_api_navigation_/#getdetailsurl","text":"\u25b8 getDetailsUrl ( details : string, resetSelected : boolean): string Defined in src/renderer/components/kube-object/kube-object-details.tsx:39 Parameters: Name Type Default details string - resetSelected boolean false Returns: string","title":"getDetailsUrl"},{"location":"extensions/api/modules/_renderer_api_navigation_/#hidedetails","text":"\u25b8 hideDetails (): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:35 Returns: void","title":"hideDetails"},{"location":"extensions/api/modules/_renderer_api_navigation_/#isactiveroute","text":"\u25b8 isActiveRoute ( route : string | string[] | RouteProps): boolean Defined in src/renderer/navigation/helpers.ts:25 Parameters: Name Type route string | string[] | RouteProps Returns: boolean","title":"isActiveRoute"},{"location":"extensions/api/modules/_renderer_api_navigation_/#navigate","text":"\u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation/helpers.ts:7 Parameters: Name Type location LocationDescriptor Returns: void","title":"navigate"},{"location":"extensions/api/modules/_renderer_api_navigation_/#showdetails","text":"\u25b8 showDetails ( details : string, resetSelected : boolean): void Defined in src/renderer/components/kube-object/kube-object-details.tsx:29 Parameters: Name Type Default details 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. --buttonLightBackground : light 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. --buttonLightBackground : light 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 = [ { components : { 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 = [ { components : { 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 # This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension. Guides # Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx 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":"This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see Your First Extension . Each guide or code sample includes the following: Clearly commented source code. Instructions for running the sample extension. An image showing the sample extension's appearance and usage. A listing of the Extension API being used. An explanation of the concepts relevant to the Extension.","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":"Lens Extension Generator # The Lens Extension Generator creates a directory with the necessary files for developing an extension. Installing and Getting Started with the Generator # To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? 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 :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources : Developing the Extension # Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello Lens\" , components : { Icon : ExampleIcon , } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens.\" To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux. Debugging the Extension # To debug your extension, please see our instructions on Testing Extensions . Next Steps # To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the Lens contribution guidelines here . The Generator source code is hosted at Github .","title":"Generator"},{"location":"extensions/guides/generator/#lens-extension-generator","text":"The Lens Extension Generator creates a directory with the necessary files for developing an extension.","title":"Lens Extension Generator"},{"location":"extensions/guides/generator/#installing-and-getting-started-with-the-generator","text":"To begin, install Yeoman and the Lens Extension Generator with the following command: npm install -g yo generator-lens-ext Run the generator by entering the following command: yo lens-ext . Answer the following questions: # ? 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 :Users\\\\.k8slens\\extensions (windows)? Yes Next, you'll need to have webpack watch the my-first-lens-ext folder. Start webpack by entering: cd my-first-lens-ext npm start # start the webpack server in watch mode Open Lens and you will see a Hello World item in the left-side menu under Custom Resources :","title":"Installing and Getting Started with the Generator"},{"location":"extensions/guides/generator/#developing-the-extension","text":"Next, you'll try changing the way the new menu item appears in the UI. You'll change it from \"Hello World\" to \"Hello Lens\". Open my-first-lens-ext/renderer.tsx and change the value of title from \"Hello World\" to \"Hello Lens\" : clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello Lens\" , components : { Icon : ExampleIcon , } } ] Reload Lens and you will see that the menu item text has changed to \"Hello Lens.\" To reload Lens, enter CMD+R on Mac and Ctrl+R on Windows/Linux.","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"To debug your extension, please see our instructions on Testing Extensions .","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#next-steps","text":"To dive deeper, consider looking at Common Capabilities , Styling , or Extension Anatomy . If you find problems with the Lens Extension Generator, or have feature requests, you are welcome to raise an issue . You can find the Lens contribution guidelines here . The Generator source code 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's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process. LensMainExtension Class # onActivate() and onDeactivate() Methods # 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' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active 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\" ); } } For more details on accessing Lens state data, please see the Stores guide. appMenus # The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an 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 that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows: parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\" , \"edit\" , \"view\" , and \"help\" . \"lens\" is valid on Mac only. label is the name of your menu item. click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending it.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#main-extension","text":"The Main Extension API is the interface to Lens's main process. Lens runs in both main and renderer processes. The Main Extension API allows you to access, configure, and customize Lens data, add custom application menu items, and run custom code in Lens's main process.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#lensmainextension-class","text":"","title":"LensMainExtension Class"},{"location":"extensions/guides/main-extension/#onactivate-and-ondeactivate-methods","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' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. To see standard output from the main process there must be a console connected to it. Achieve this by starting Lens from the command prompt. The following example is a little more interesting. It accesses some Lens state data, and it periodically logs the name of the cluster that is currently active 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\" ); } } For more details on accessing Lens state data, please see the Stores guide.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/main-extension/#appmenus","text":"The Main Extension API allows you to customize the UI application menu. Note that this is the only UI feature that the Main Extension API allows you to customize. The following example demonstrates adding an 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 that satisfy the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. The properties of the appMenus array objects are defined as follows: parentId is the name of the menu where your new menu item will be listed. Valid values include: \"file\" , \"edit\" , \"view\" , and \"help\" . \"lens\" is valid on Mac only. label is the name of your menu item. click() is called when the menu item is selected. In this example, we simply log a message. However, you would typically have this navigate to a specific page or perform another operation. Note that pages are associated with the LensRendererExtension class and can be defined in the process of extending 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 both the main and renderer processes. The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, and run custom code in Lens's renderer process. The custom Lens UI elements that you can add include: Cluster pages Cluster page menus Global pages Global page menus Cluster features App preferences Status bar items KubeObject menu items KubeObject detail items All UI elements are based on React components. LensRendererExtension Class # onActivate() and onDeactivate() Methods # To create a renderer extension, 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' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Info Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled. clusterPages # Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with clusterStore . Add a cluster page definition to a LensRendererExtension subclass with the following example: 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 } /> , } } ]; } clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows: id is a string that identifies the page. components matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType . It offers flexibility in defining the appearance and behavior of your page. ExamplePage in the example above 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 the extension property. This allows the ExampleExtension object to be passed in the cluster page definition in the React style. This way, ExamplePage can access all ExampleExtension subclass data. The above example shows how to create a cluster page, but not how to make that page available to the Lens user. Use clusterPageMenus , covered in the next section, to add cluster pages to the Lens UI. clusterPageMenus # clusterPageMenus allows you to add cluster page menu items to the secondary left nav. By expanding on the above example, you can add a cluster page menu item 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 , } }, ]; } clusterPageMenus is an array of objects that satisfy the ClusterPageMenuRegistration interface. This element defines how the cluster page menu item will appear and what it will do when you click it. The properties of the clusterPageMenus array objects are defined as follows: target links to the relevant cluster page using pageId . pageId takes the value of the relevant cluster page's id property. title sets the name of the cluster page menu item that will appear in the left side menu. components is used to set an icon that appears to the left of the title text in the left side menu. The above example creates a menu item that reads Hello World . When users click Hello World , the cluster dashboard will show the contents of Example Page . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx , as follows: 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> ) } } Lens includes various built-in components available for extension developers to use. One of these is the Component.Icon , introduced in ExampleIcon , which you can use to access any of the icons available at Material Design . The properties that Component.Icon uses are defined as follows: material takes the name of the icon you want to use. tooltip sets the text you want to appear when a user hovers over the icon. clusterPageMenus can also be used to define sub menu items, so that you can create groups of cluster pages. The following example groups two sub menu items under one parent menu item: 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 definitions are straightforward. The three cluster page menu objects include one parent menu item and two sub menu items. 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. This is what the example will look like, including how the menu item will appear in the secondary left nav: globalPages # Global pages are independent of the cluster dashboard and can fill the entire Lens UI. Their primary use is to display information and provide functionality across clusters, including customized data and functionality unique to your extension. Typically, you would use a global page menu located in the left nav to trigger a global page. You can also trigger a global page with a custom app menu selection from a Main Extension or a custom status bar item . Unlike cluster pages, users can trigger global pages even when there is no active cluster. 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 } /> , } } ]; } globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows: id is a string that identifies the page. components matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType . It offers flexibility in defining the appearance and behavior of your page. HelpPage in the example above 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 the extension property. This allows the HelpExtension object to be passed in the global page definition in the React-style. This way, HelpPage can access all HelpExtension subclass data. This example code shows how to create a global page, but not how to make that page available to the Lens user. Global pages can be made available in the following ways: To add global pages to the top menu bar, see appMenus in the Main Extension guide. To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems . To add global pages to the left side menu, see globalPageMenus . globalPageMenus # globalPageMenus allows you to add global page menu items to the left nav. By expanding on the above example, you can add a global page menu item 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 , } }, ]; } globalPageMenus is an array of objects that satisfy the PageMenuRegistration interface. This element defines how the global page menu item will appear and what it will do when you click it. The properties of the globalPageMenus array objects are defined as follows: target links to the relevant global page using pageId . pageId takes the value of the relevant global page's id property. title sets the name of the global page menu item that will display as a tooltip in the left nav. components is used to set an icon that appears in the left nav. The above example creates a \"Help\" icon menu item. When users click the icon, the Lens UI will display the contents of ExamplePage . This example requires the definition of another React-based component, HelpIcon . Update page.tsx from the example above with the HelpIcon definition, as follows: 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> ) } } Lens includes various built-in components available for extension developers to use. One of these is the Component.Icon , introduced in HelpIcon , which you can use to access any of the icons available at Material Design . The property that Component.Icon uses is defined as follows: material takes the name of the icon you want to use. This is what the example will look like, including how the menu item will appear in the left nav: clusterFeatures # Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed and uninstalled by the Lens user from the cluster Settings page. Info To access the cluster Settings page, right-click the relevant cluster in the left side menu and click Settings . 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 properties of the clusterFeatures array objects are defined as follows: title and components.Description provide content that appears on the cluster settings page, in the Features section. feature specifies an instance which extends the abstract class ClusterFeature.Feature , and specifically implements 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 four methods listed above are defined as follows: The install() method installs Kubernetes resources using the applyResources() method, or by directly accessing the Kubernetes API . This method is typically called when a user indicates that they want to install the feature (i.e., by clicking Install for the feature in the cluster settings page). The upgrade() method upgrades the Kubernetes resources already installed, if they are relevant to the feature. This method is typically called when a user indicates that they want to upgrade the feature (i.e., by clicking Upgrade for the feature in the cluster settings page). The uninstall() method uninstalls Kubernetes resources using the Kubernetes API . This method is typically called when a user indicates that they want to uninstall the feature (i.e., by clicking Uninstall for the feature in the cluster settings page). The updateStatus() method provides the current status information in the status field of the ClusterFeature.Feature parent class. Lens periodically calls this method to determine details about the feature's current status. The implementation of this method should uninstall Kubernetes resources using the Kubernetes api ( K8sApi ) Consider using the following properties with updateStatus() : status.currentVersion and status.latestVersion may be displayed by Lens in the feature's description. status.installed should be set to true if the feature is installed, and false otherwise. status.canUpgrade is set according to a rule meant to determine whether the feature can be upgraded. This rule can involve status.currentVersion and status.latestVersion , if desired. 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 invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case the folder path is the ../resources subfolder relative to the 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 example above implements the four methods as follows: It implements upgrade() by invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. It implements uninstall() by utilizing the Kubernetes API which Lens provides to delete the example-pod applied by the install() method. It implements updateStatus() by using the Kubernetes API which Lens provides to determine whether the example-pod is installed, what version is associated with it, and whether it can be upgraded. The implementation determines what the status is for a specific cluster feature. appPreferences # The Lens Preferences page is a built-in global page. You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options. 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 /> } } ]; } appPreferences is an array of objects that satisfies the AppPreferenceRegistration interface. The properties of the appPreferences array objects are defined as follows: title sets the heading text displayed on the Preferences page. components specifies two React.Component objects that define the interface for the preference. Input specifies an interactive input element for the preference. Hint provides descriptive information for the preference, shown below the Input element. Note Note that the input and the hint can be comprised of more sophisticated elements, according to the needs of the extension. ExamplePreferenceInput expects its React props to be set to an ExamplePreferenceProps instance. This is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has a preference field, which you will add to ExamplePreferenceInput . In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx as follows: 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 using the following properties: label sets the text that displays next to the checkbox. value is initially set to preference.enabled . onChange is a function that responds when the state of the checkbox changes. ExamplePreferenceInput is defined with the ExamplePreferenceProps React props. This is an object with the single enabled property. It is used to indicate the state of the preference, and it is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. The above example introduces the decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management. 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. We recommend that extensions rely on it, as well. Alternatively, you can use React's state management, though mobx is typically simpler to use. Note that you can manage an extension's state data using an ExtensionStore object, which conveniently handles persistence and synchronization. To simplify this guide, the example above defines a preference field in the ExampleRendererExtension class definition to hold the extension's state. However, we recommend that you manage your extension's state data using ExtensionStore . statusBarItems # The status bar is the blue strip along the bottom of the Lens UI. statusBarItems are React.ReactNode types. They can be used to display status information, or act as links to global pages as well as external pages. The following example adds a statusBarItems definition and a globalPages definition to a LensRendererExtension subclass. It 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 = [ { components : { Item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ) }, }, ]; } The properties of the statusBarItems array objects are defined as follows: Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide . onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages. kubeObjectMenuItems # An extension can add custom menu items ( kubeObjectMenuItems ) for specific Kubernetes resource kinds and apiVersions. kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard: They also appear on the title bar of the details page for specific resources: The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action: 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 } /> } } ]; } kubeObjectMenuItems is an array of objects matching the KubeObjectMenuRegistration interface. The example above adds a menu item for namespaces in the cluster dashboard. The properties of the kubeObjectMenuItems array objects are defined as follows: kind specifies the Kubernetes resource type the menu item will apply to. apiVersion specifies the Kubernetes API version number to use with the resource type. components defines the menu item's appearance and behavior. MenuItem 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 which defines the menu item's appearance and its behavior when activated via the onClick property. In the example, getPods() opens a terminal tab and runs kubectl to get a list of pods running in the current namespace. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName() . Thus, kubeObjectMenuItems afford convenient access to the specific resource selected by the user. kubeObjectDetailItems # An extension can add custom details ( kubeObjectDetailItems ) for specified Kubernetes resource kinds and apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace as shown here: The following example shows how to use kubeObjectDetailItems 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 } /> } } ]; } kubeObjectDetailItems is an array of objects matching the KubeObjectDetailRegistration interface. This example above adds a detail item for namespaces in the cluster dashboard. The properties of the kubeObjectDetailItems array objects are defined as follows: kind specifies the Kubernetes resource type the detail item will apply to. apiVersion specifies the Kubernetes API version number to use with the resource type. components defines the detail item's appearance and behavior. Details 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 . You can query this object for many details about the current namespace. In the example above, componentDidMount() gets the namespace's name using the K8sApi.Namespace getName() method. Use the namespace's name to limit the list of pods only to those in the relevant namespace. To get this list of pods, this example uses the Kubernetes pods API K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the active cluster. Note that K8sApi.podsApi.list() is an asynchronous method. Getting the pods list should occur prior to 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 updates. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem renders 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: Obtain the name, age, and status for each pod using the K8sApi.Pod methods. Construct the table using the Component.Table and related elements. 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 both the main and renderer processes. The Renderer Extension API allows you to access, configure, and customize Lens data, add custom Lens UI elements, and run custom code in Lens's renderer process. The custom Lens UI elements that you can add include: Cluster pages Cluster page menus Global pages Global page menus Cluster features App preferences Status bar items KubeObject menu items KubeObject detail items All UI elements are based on React components.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#lensrendererextension-class","text":"","title":"LensRendererExtension Class"},{"location":"extensions/guides/renderer-extension/#onactivate-and-ondeactivate-methods","text":"To create a renderer extension, 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' ); } } Two methods enable you to run custom code: onActivate() and onDeactivate() . Enabling your extension calls onActivate() and disabling your extension calls onDeactivate() . You can initiate custom code by implementing onActivate() . Implementing onDeactivate() gives you the opportunity to clean up after your extension. Info Disable extensions from the Lens Extensions page: Navigate to File > Extensions in the top menu bar. (On Mac, it is Lens > Extensions .) Click Disable on the extension you want to disable. The example above logs messages when the extension is enabled and disabled.","title":"onActivate() and onDeactivate() Methods"},{"location":"extensions/guides/renderer-extension/#clusterpages","text":"Cluster pages appear in the cluster dashboard. Use cluster pages to display information about or add functionality to the active cluster. It is also possible to include custom details from other clusters. Use your extension to access Kubernetes resources in the active cluster with clusterStore . Add a cluster page definition to a LensRendererExtension subclass with the following example: 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 } /> , } } ]; } clusterPages is an array of objects that satisfy the PageRegistration interface. The properties of the clusterPages array objects are defined as follows: id is a string that identifies the page. components matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType . It offers flexibility in defining the appearance and behavior of your page. ExamplePage in the example above 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 the extension property. This allows the ExampleExtension object to be passed in the cluster page definition in the React style. This way, ExamplePage can access all ExampleExtension subclass data. The above example shows how to create a cluster page, but not how to make that page available to the Lens user. Use clusterPageMenus , covered in the next section, to add cluster pages to the Lens UI.","title":"clusterPages"},{"location":"extensions/guides/renderer-extension/#clusterpagemenus","text":"clusterPageMenus allows you to add cluster page menu items to the secondary left nav. By expanding on the above example, you can add a cluster page menu item 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 , } }, ]; } clusterPageMenus is an array of objects that satisfy the ClusterPageMenuRegistration interface. This element defines how the cluster page menu item will appear and what it will do when you click it. The properties of the clusterPageMenus array objects are defined as follows: target links to the relevant cluster page using pageId . pageId takes the value of the relevant cluster page's id property. title sets the name of the cluster page menu item that will appear in the left side menu. components is used to set an icon that appears to the left of the title text in the left side menu. The above example creates a menu item that reads Hello World . When users click Hello World , the cluster dashboard will show the contents of Example Page . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx , as follows: 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> ) } } Lens includes various built-in components available for extension developers to use. One of these is the Component.Icon , introduced in ExampleIcon , which you can use to access any of the icons available at Material Design . The properties that Component.Icon uses are defined as follows: material takes the name of the icon you want to use. tooltip sets the text you want to appear when a user hovers over the icon. clusterPageMenus can also be used to define sub menu items, so that you can create groups of cluster pages. The following example groups two sub menu items under one parent menu item: 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 definitions are straightforward. The three cluster page menu objects include one parent menu item and two sub menu items. 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. This is what the example will look like, including how the menu item will appear in the secondary left nav:","title":"clusterPageMenus"},{"location":"extensions/guides/renderer-extension/#globalpages","text":"Global pages are independent of the cluster dashboard and can fill the entire Lens UI. Their primary use is to display information and provide functionality across clusters, including customized data and functionality unique to your extension. Typically, you would use a global page menu located in the left nav to trigger a global page. You can also trigger a global page with a custom app menu selection from a Main Extension or a custom status bar item . Unlike cluster pages, users can trigger global pages even when there is no active cluster. 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 } /> , } } ]; } globalPages is an array of objects that satisfy the PageRegistration interface. The properties of the globalPages array objects are defined as follows: id is a string that identifies the page. components matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType . It offers flexibility in defining the appearance and behavior of your page. HelpPage in the example above 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 the extension property. This allows the HelpExtension object to be passed in the global page definition in the React-style. This way, HelpPage can access all HelpExtension subclass data. This example code shows how to create a global page, but not how to make that page available to the Lens user. Global pages can be made available in the following ways: To add global pages to the top menu bar, see appMenus in the Main Extension guide. To add global pages as an interactive element in the blue status bar along the bottom of the Lens UI, see statusBarItems . To add global pages to the left side menu, see globalPageMenus .","title":"globalPages"},{"location":"extensions/guides/renderer-extension/#globalpagemenus","text":"globalPageMenus allows you to add global page menu items to the left nav. By expanding on the above example, you can add a global page menu item 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 , } }, ]; } globalPageMenus is an array of objects that satisfy the PageMenuRegistration interface. This element defines how the global page menu item will appear and what it will do when you click it. The properties of the globalPageMenus array objects are defined as follows: target links to the relevant global page using pageId . pageId takes the value of the relevant global page's id property. title sets the name of the global page menu item that will display as a tooltip in the left nav. components is used to set an icon that appears in the left nav. The above example creates a \"Help\" icon menu item. When users click the icon, the Lens UI will display the contents of ExamplePage . This example requires the definition of another React-based component, HelpIcon . Update page.tsx from the example above with the HelpIcon definition, as follows: 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> ) } } Lens includes various built-in components available for extension developers to use. One of these is the Component.Icon , introduced in HelpIcon , which you can use to access any of the icons available at Material Design . The property that Component.Icon uses is defined as follows: material takes the name of the icon you want to use. This is what the example will look like, including how the menu item will appear in the left nav:","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 and uninstalled by the Lens user from the cluster Settings page. Info To access the cluster Settings page, right-click the relevant cluster in the left side menu and click Settings . 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 properties of the clusterFeatures array objects are defined as follows: title and components.Description provide content that appears on the cluster settings page, in the Features section. feature specifies an instance which extends the abstract class ClusterFeature.Feature , and specifically implements 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 four methods listed above are defined as follows: The install() method installs Kubernetes resources using the applyResources() method, or by directly accessing the Kubernetes API . This method is typically called when a user indicates that they want to install the feature (i.e., by clicking Install for the feature in the cluster settings page). The upgrade() method upgrades the Kubernetes resources already installed, if they are relevant to the feature. This method is typically called when a user indicates that they want to upgrade the feature (i.e., by clicking Upgrade for the feature in the cluster settings page). The uninstall() method uninstalls Kubernetes resources using the Kubernetes API . This method is typically called when a user indicates that they want to uninstall the feature (i.e., by clicking Uninstall for the feature in the cluster settings page). The updateStatus() method provides the current status information in the status field of the ClusterFeature.Feature parent class. Lens periodically calls this method to determine details about the feature's current status. The implementation of this method should uninstall Kubernetes resources using the Kubernetes api ( K8sApi ) Consider using the following properties with updateStatus() : status.currentVersion and status.latestVersion may be displayed by Lens in the feature's description. status.installed should be set to true if the feature is installed, and false otherwise. status.canUpgrade is set according to a rule meant to determine whether the feature can be upgraded. This rule can involve status.currentVersion and status.latestVersion , if desired. 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 invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case the folder path is the ../resources subfolder relative to the 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 example above implements the four methods as follows: It implements upgrade() by invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. It implements uninstall() by utilizing the Kubernetes API which Lens provides to delete the example-pod applied by the install() method. It implements updateStatus() by using the Kubernetes API which Lens provides to determine whether the example-pod is installed, what version is associated with it, and whether it can be upgraded. The implementation determines what the status is for a specific cluster feature.","title":"clusterFeatures"},{"location":"extensions/guides/renderer-extension/#apppreferences","text":"The Lens Preferences page is a built-in global page. You can use Lens extensions to add custom preferences to the Preferences page, providing a single location for users to configure global options. 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 /> } } ]; } appPreferences is an array of objects that satisfies the AppPreferenceRegistration interface. The properties of the appPreferences array objects are defined as follows: title sets the heading text displayed on the Preferences page. components specifies two React.Component objects that define the interface for the preference. Input specifies an interactive input element for the preference. Hint provides descriptive information for the preference, shown below the Input element. Note Note that the input and the hint can be comprised of more sophisticated elements, according to the needs of the extension. ExamplePreferenceInput expects its React props to be set to an ExamplePreferenceProps instance. This is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has a preference field, which you will add to ExamplePreferenceInput . In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx as follows: 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 using the following properties: label sets the text that displays next to the checkbox. value is initially set to preference.enabled . onChange is a function that responds when the state of the checkbox changes. ExamplePreferenceInput is defined with the ExamplePreferenceProps React props. This is an object with the single enabled property. It is used to indicate the state of the preference, and it is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. The above example introduces the decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management. 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. We recommend that extensions rely on it, as well. Alternatively, you can use React's state management, though mobx is typically simpler to use. Note that you can manage an extension's state data using an ExtensionStore object, which conveniently handles persistence and synchronization. To simplify this guide, the example above defines a preference field in the ExampleRendererExtension class definition to hold the extension's state. However, we recommend that you 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. statusBarItems are React.ReactNode types. They can be used to display status information, or act as links to global pages as well as external pages. The following example adds a statusBarItems definition and a globalPages definition to a LensRendererExtension subclass. It 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 = [ { components : { Item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ) }, }, ]; } The properties of the statusBarItems array objects are defined as follows: Item specifies the React.Component that will be shown on the status bar. By default, items are added starting from the right side of the status bar. Due to limited space in the status bar, Item will typically specify only an icon or a short string of text. The example above reuses the HelpIcon from the globalPageMenus guide . onClick determines what the statusBarItem does when it is clicked. In the example, onClick is set to a function that calls the LensRendererExtension navigate() method. navigate takes the id of the associated global page as a parameter. Thus, clicking the status bar item activates the associated global pages.","title":"statusBarItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectmenuitems","text":"An extension can add custom menu items ( kubeObjectMenuItems ) for specific Kubernetes resource kinds and apiVersions. kubeObjectMenuItems appear under the vertical ellipsis for each listed resource in the cluster dashboard: They also appear on the title bar of the details page for specific resources: The following example shows how to add a kubeObjectMenuItems for namespace resources with an associated action: 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 } /> } } ]; } kubeObjectMenuItems is an array of objects matching the KubeObjectMenuRegistration interface. The example above adds a menu item for namespaces in the cluster dashboard. The properties of the kubeObjectMenuItems array objects are defined as follows: kind specifies the Kubernetes resource type the menu item will apply to. apiVersion specifies the Kubernetes API version number to use with the resource type. components defines the menu item's appearance and behavior. MenuItem 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 which defines the menu item's appearance and its behavior when activated via the onClick property. In the example, getPods() opens a terminal tab and runs kubectl to get a list of pods running in the current namespace. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . K8sApi.Namespace is the API for accessing namespaces. The current namespace in this example is simply given by namespace.getName() . Thus, kubeObjectMenuItems afford 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 ( kubeObjectDetailItems ) for specified Kubernetes resource kinds and apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace as shown here: The following example shows how to use kubeObjectDetailItems 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 } /> } } ]; } kubeObjectDetailItems is an array of objects matching the KubeObjectDetailRegistration interface. This example above adds a detail item for namespaces in the cluster dashboard. The properties of the kubeObjectDetailItems array objects are defined as follows: kind specifies the Kubernetes resource type the detail item will apply to. apiVersion specifies the Kubernetes API version number to use with the resource type. components defines the detail item's appearance and behavior. Details 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 . You can query this object for many details about the current namespace. In the example above, componentDidMount() gets the namespace's name using the K8sApi.Namespace getName() method. Use the namespace's name to limit the list of pods only to those in the relevant namespace. To get this list of pods, this example uses the Kubernetes pods API K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the active cluster. Note that K8sApi.podsApi.list() is an asynchronous method. Getting the pods list should occur prior to 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 updates. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem renders 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: Obtain the name, age, and status for each pod using the K8sApi.Pod methods. Construct the table using the Component.Table and related elements. 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 uses a number of stores to maintain various kinds of state information, including: The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active. The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace. The ExtensionStore manages custom extension state data. This guide focuses on the ExtensionStore . 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 or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted. 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, our example defines the extension's data model using the simple ExamplePreferencesModel type. This has a single field, enabled , which represents the preference's state. ExamplePreferencesStore extends Store.ExtensionStore , which is based on the ExamplePreferencesModel . The enabled field is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observable decorator on the enabled field. The appPreferences guide example uses MobX for the UI state management, ensuring the checkbox updates when it's activated by the user. Next, our example implements the constructor and two abstract methods. The constructor specifies the name of the store ( \"example-preferences-store\" ) and the default (initial) value for the preference state ( enabled: false ). Lens internals call the fromStore() method when the store loads. It gives the extension the opportunity to retrieve the stored state data values based on the defined data model. 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() . It 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 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 loads with examplePreferencesStore.loadExtension(this) , which is conveniently called from the onActivate() method of ExampleMainExtension . Similarly, examplePreferencesStore must load 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 . There is no longer the need for the preference field in the ExampleRendererExtension class because 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 that 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 uses a number of stores to maintain various kinds of state information, including: The ClusterStore manages cluster state data (such as cluster details), and it tracks which cluster is active. The WorkspaceStore manages workspace state data (such as the workspace name), and and it tracks which clusters belong to a given workspace. The ExtensionStore manages custom extension state data. This guide focuses on the ExtensionStore .","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 or not something is enabled. However, in the example, the enabled state is not stored anywhere, and it reverts to the default when Lens is restarted. 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, our example defines the extension's data model using the simple ExamplePreferencesModel type. This has a single field, enabled , which represents the preference's state. ExamplePreferencesStore extends Store.ExtensionStore , which is based on the ExamplePreferencesModel . The enabled field is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observable decorator on the enabled field. The appPreferences guide example uses MobX for the UI state management, ensuring the checkbox updates when it's activated by the user. Next, our example implements the constructor and two abstract methods. The constructor specifies the name of the store ( \"example-preferences-store\" ) and the default (initial) value for the preference state ( enabled: false ). Lens internals call the fromStore() method when the store loads. It gives the extension the opportunity to retrieve the stored state data values based on the defined data model. 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() . It 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 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 loads with examplePreferencesStore.loadExtension(this) , which is conveniently called from the onActivate() method of ExampleMainExtension . Similarly, examplePreferencesStore must load 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 . There is no longer the need for the preference field in the ExampleRendererExtension class because 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 that 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 on top of React's state management system. The result is a more declarative state management style, rather than React's native setState mechanism. You can review how React handles state management here . The following is a quick overview: React.Component is generic with respect to both props and state (which default to the empty object type). props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component. state is a component's internal state, and can be read by accessing the super-class field state . state must be updated using the setState parent method which merges the new data with the old state. React does 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 system. The three main concepts are: observable is a marker for data stored in the component's state . action is a function that modifies any observable data. computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count . Further reading is available on the MobX 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 on top of React's state management system. The result is a more declarative state management style, rather than React's native setState mechanism. You can review how React handles state management here . The following is a quick overview: React.Component is generic with respect to both props and state (which default to the empty object type). props should be considered read-only from the point of view of the component, and it is the mechanism for passing in arguments to a component. state is a component's internal state, and can be read by accessing the super-class field state . state must be updated using the setState parent method which merges the new data with the old state. React does 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 system. The three main concepts are: observable is a marker for data stored in the component's state . action is a function that modifies any observable data. computed is a marker for data that is derived from observable data, but that is not actually stored. Think of this as computing isEmpty rather than an observable field called count . Further reading is available on the MobX 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 => ( < 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)","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 => ( < 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.","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 Why Lens window rendering is broken? # MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display . Same thing can happen with any of Electron applications or Chrome itself. As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app. First, open .bash_profile file from your terminal open -a TextEdit.app ~/.bash_profile Then, add this line export LENS_DISABLE_GPU=true","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":"faq/#why-lens-window-rendering-is-broken","text":"MacOS users can encouter visual bug with fuzzy lines appeared while connected to external 4K display . Same thing can happen with any of Electron applications or Chrome itself. As a temporary workaround there is a possibility to disable Chromium GPU acceleration. To do this for Lens, you need to provide LENS_DISABLE_GPU=true env variable and relaunch app. First, open .bash_profile file from your terminal open -a TextEdit.app ~/.bash_profile Then, add this line export LENS_DISABLE_GPU=true","title":"Why Lens window rendering is broken?"},{"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/v4.1.0/sitemap.xml b/v4.1.0/sitemap.xml new file mode 100644 index 0000000000..885e7a0570 --- /dev/null +++ b/v4.1.0/sitemap.xml @@ -0,0 +1,131 @@ + + + https://docs.k8slens.dev/ + 2021-02-16 + daily + + https://docs.k8slens.dev/getting-started/ + 2021-02-16 + daily + + https://docs.k8slens.dev/clusters/adding-clusters/ + 2021-02-16 + daily + + https://docs.k8slens.dev/clusters/removing-clusters/ + 2021-02-16 + daily + + https://docs.k8slens.dev/clusters/settings/ + 2021-02-16 + daily + + https://docs.k8slens.dev/helm/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/usage/ + 2021-02-16 + daily + + https://docs.k8slens.dev/getting-started/preferences/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/get-started/overview/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/get-started/your-first-extension/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/get-started/anatomy/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/get-started/wrapping-up/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/capabilities/common-capabilities/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/capabilities/styling/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/capabilities/color-reference/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/guides/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/guides/generator/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/guides/main-extension/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/guides/renderer-extension/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/guides/stores/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/guides/working-with-mobx/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/testing-and-publishing/testing/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/testing-and-publishing/publishing/ + 2021-02-16 + daily + + https://docs.k8slens.dev/extensions/api/ + 2021-02-16 + daily + + https://docs.k8slens.dev/contributing/ + 2021-02-16 + daily + + https://docs.k8slens.dev/contributing/development/ + 2021-02-16 + daily + + https://docs.k8slens.dev/contributing/documentation/ + 2021-02-16 + daily + + https://docs.k8slens.dev/contributing/maintainers/ + 2021-02-16 + daily + + https://docs.k8slens.dev/contributing/promotion/ + 2021-02-16 + daily + + https://docs.k8slens.dev/support/ + 2021-02-16 + daily + + https://docs.k8slens.dev/faq/ + 2021-02-16 + daily + + \ No newline at end of file diff --git a/v4.1.0/sitemap.xml.gz b/v4.1.0/sitemap.xml.gz new file mode 100644 index 0000000000..49bb2c5451 Binary files /dev/null and b/v4.1.0/sitemap.xml.gz differ diff --git a/v4.1.0/stylesheets/extra.css b/v4.1.0/stylesheets/extra.css new file mode 100644 index 0000000000..f727034bbd --- /dev/null +++ b/v4.1.0/stylesheets/extra.css @@ -0,0 +1,90 @@ +:root { + --md-primary-fg-color: #3d90ce; + --md-accent-fg-color: #3d90ce; +} + +:root > * { + /* Footer */ + --md-footer-bg-color: #3d90ce; +} + +.md-version__list { + overflow: auto; +} + +ul.video-list { + counter-reset: section; + list-style: none; + padding-left: 0; + position:relative +} + +ul.video-list .video:not(:last-of-type) a { + border-bottom:2px solid #e6e6e6 +} + +ul.video-list a { + position: relative; + padding: 2rem 2rem 2rem 4.2rem; + display: block; + box-sizing:border-box +} + +ul.video-list a .info { + padding-top:0.25rem +} + +ul.video-list a .info::before { + counter-increment: section; + content: counter(section); + position: absolute; + left: 1.5rem; + color:black +} + +ul.video-list a .info > p, ul.video-list a .info > span { + color:black +} + +ul.video-list a .info .title { + margin-top: 0; + margin-bottom:0.7rem +} + +ul.video-list a .info .description { + margin-bottom: 1rem; + +} + +ul.video-list a .info .duration, ul.video-list a .info .duration span { + color: #6e6e6e; + +} + +ul.video-list a:hover, ul.video-list a:focus { + text-decoration:none +} + +ul.video-list a:hover { + background:#f2f2f2 +} + +ul.video-list a:hover::after { + content: ''; + display: block; + width: 6rem; + height: 6rem; + position: absolute; + background: url("/img/play.svg"); + background-size: 6rem; + top: 3rem; + left:8.6rem +} + +ul.video-list .thumb { + max-height: 8.2rem; + padding-right: 2rem; + position: relative; + float:left +} + diff --git a/v4.1.0/support/index.html b/v4.1.0/support/index.html new file mode 100644 index 0000000000..e123289117 --- /dev/null +++ b/v4.1.0/support/index.html @@ -0,0 +1,1013 @@ + + + + + + + + + + + + + + + + + + + + + + Support - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.1.0/supporting/requirements/index.html b/v4.1.0/supporting/requirements/index.html new file mode 100644 index 0000000000..71c93a9871 --- /dev/null +++ b/v4.1.0/supporting/requirements/index.html @@ -0,0 +1,959 @@ + + + + + + + + + + + + + + + + + + + + + + Requirements for Lens - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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#

    +

    ...

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/versions.json b/versions.json index 877f1bbdd6..b2f169f6ff 100644 --- a/versions.json +++ b/versions.json @@ -1 +1 @@ -[{"version": "v4.0.8", "title": "v4.0.8", "aliases": ["latest"]}, {"version": "v4.0.7", "title": "v4.0.7", "aliases": []}, {"version": "v4.0.6", "title": "v4.0.6", "aliases": []}, {"version": "v4.0.5", "title": "v4.0.5", "aliases": []}, {"version": "v4.0.4", "title": "v4.0.4", "aliases": []}, {"version": "v4.0.3", "title": "v4.0.3", "aliases": []}, {"version": "v4.0.2", "title": "v4.0.2", "aliases": []}, {"version": "v4.0.1", "title": "v4.0.1", "aliases": []}, {"version": "v4.0.0", "title": "v4.0.0", "aliases": []}, {"version": "master", "title": "master", "aliases": []}] \ No newline at end of file +[{"version": "v4.1.0", "title": "v4.1.0", "aliases": ["latest"]}, {"version": "v4.0.8", "title": "v4.0.8", "aliases": []}, {"version": "v4.0.7", "title": "v4.0.7", "aliases": []}, {"version": "v4.0.6", "title": "v4.0.6", "aliases": []}, {"version": "v4.0.5", "title": "v4.0.5", "aliases": []}, {"version": "v4.0.4", "title": "v4.0.4", "aliases": []}, {"version": "v4.0.3", "title": "v4.0.3", "aliases": []}, {"version": "v4.0.2", "title": "v4.0.2", "aliases": []}, {"version": "v4.0.1", "title": "v4.0.1", "aliases": []}, {"version": "v4.0.0", "title": "v4.0.0", "aliases": []}, {"version": "master", "title": "master", "aliases": []}] \ No newline at end of file