diff --git a/latest/404.html b/latest/404.html index 381af988bf..db9839c8e5 100644 --- a/latest/404.html +++ b/latest/404.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../v4.2.4/404.html... + Redirecting to ../v4.2.5/404.html... \ No newline at end of file diff --git a/latest/clusters/adding-clusters/index.html b/latest/clusters/adding-clusters/index.html new file mode 100644 index 0000000000..bbc3225cfa --- /dev/null +++ b/latest/clusters/adding-clusters/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/clusters/adding-clusters/... + + \ No newline at end of file diff --git a/latest/clusters/removing-clusters/index.html b/latest/clusters/removing-clusters/index.html new file mode 100644 index 0000000000..b7dd669020 --- /dev/null +++ b/latest/clusters/removing-clusters/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/clusters/removing-clusters/... + + \ No newline at end of file diff --git a/latest/clusters/settings/index.html b/latest/clusters/settings/index.html new file mode 100644 index 0000000000..14d9a716c2 --- /dev/null +++ b/latest/clusters/settings/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/clusters/settings/... + + \ No newline at end of file diff --git a/latest/contributing/development/index.html b/latest/contributing/development/index.html new file mode 100644 index 0000000000..ac5a5f0bb5 --- /dev/null +++ b/latest/contributing/development/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/contributing/development/... + + \ No newline at end of file diff --git a/latest/contributing/documentation/index.html b/latest/contributing/documentation/index.html new file mode 100644 index 0000000000..c679348e64 --- /dev/null +++ b/latest/contributing/documentation/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/contributing/documentation/... + + \ No newline at end of file diff --git a/latest/contributing/github_workflow/index.html b/latest/contributing/github_workflow/index.html new file mode 100644 index 0000000000..eec7179d0d --- /dev/null +++ b/latest/contributing/github_workflow/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/contributing/github_workflow/... + + \ No newline at end of file diff --git a/latest/contributing/index.html b/latest/contributing/index.html new file mode 100644 index 0000000000..cbb8b1a946 --- /dev/null +++ b/latest/contributing/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../v4.2.5/contributing/... + + \ No newline at end of file diff --git a/latest/contributing/maintainers/index.html b/latest/contributing/maintainers/index.html new file mode 100644 index 0000000000..15bfdc4de2 --- /dev/null +++ b/latest/contributing/maintainers/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/contributing/maintainers/... + + \ No newline at end of file diff --git a/latest/contributing/promotion/index.html b/latest/contributing/promotion/index.html new file mode 100644 index 0000000000..547eaeddaa --- /dev/null +++ b/latest/contributing/promotion/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/contributing/promotion/... + + \ No newline at end of file diff --git a/latest/contributing/testing/index.html b/latest/contributing/testing/index.html new file mode 100644 index 0000000000..a675118d98 --- /dev/null +++ b/latest/contributing/testing/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/contributing/testing/... + + \ No newline at end of file diff --git a/latest/custom_theme/main.html b/latest/custom_theme/main.html index 09446c4ed3..f48c8cbc45 100644 --- a/latest/custom_theme/main.html +++ b/latest/custom_theme/main.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../v4.2.4/custom_theme/main.html... + Redirecting to ../../v4.2.5/custom_theme/main.html... \ No newline at end of file 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 e5eb638c6b..b691110612 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/... \ No newline at end of file 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 766d742f04..c816c114b0 100644 --- a/latest/extensions/api/classes/_core_api_stores_.cluster/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_core_api_stores_.cluster/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_core_api_stores_.cluster/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html index 7a4bb14992..8dfb2cfe46 100644 --- a/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_core_api_stores_.clusterstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_core_api_stores_.clusterstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html index f1b3377af7..433e550eeb 100644 --- a/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_core_api_stores_.extensionstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_core_api_stores_.extensionstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_core_api_stores_.workspace/index.html b/latest/extensions/api/classes/_core_api_stores_.workspace/index.html index abc8a78b6f..1dfc144197 100644 --- a/latest/extensions/api/classes/_core_api_stores_.workspace/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.workspace/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_core_api_stores_.workspace/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_core_api_stores_.workspace/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html index f921767b4c..2968d44121 100644 --- a/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_core_api_stores_.workspacestore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_core_api_stores_.workspacestore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_core_api_utils_.singleton/index.html b/latest/extensions/api/classes/_core_api_utils_.singleton/index.html index dccc1b82d0..e35da9fdd8 100644 --- a/latest/extensions/api/classes/_core_api_utils_.singleton/index.html +++ b/latest/extensions/api/classes/_core_api_utils_.singleton/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_core_api_utils_.singleton/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_core_api_utils_.singleton/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.badge/index.html b/latest/extensions/api/classes/_renderer_api_components_.badge/index.html index 41f9a3e35f..114aca27c2 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.badge/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.badge/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.badge/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.badge/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.button/index.html b/latest/extensions/api/classes/_renderer_api_components_.button/index.html index f9b00f634f..739118ee8c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.button/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.button/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.button/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.button/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html b/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html index a9e0fb859d..174f17b614 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.checkbox/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.checkbox/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html b/latest/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html index 5535784207..48c64334f1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.commandoverlay/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.commandoverlay/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html b/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html index d136e2e800..e47ee66da0 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.confirmdialog/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.confirmdialog/... \ No newline at end of file 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 139d38e503..3cc146fddf 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.cubespinner/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.cubespinner/... \ No newline at end of file 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 547c29da6d..ba903ebc8a 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.dialog/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.dialog/... \ No newline at end of file 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 578da5c1d3..41d4595c2e 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.drawer/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.drawer/... \ No newline at end of file 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 8800f9975d..69fc74af15 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.draweritem/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.draweritem/... \ No newline at end of file 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 d7f6e7c76b..776baa030c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/... \ No newline at end of file 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 57da4f7061..3a27596425 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.drawertitle/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.drawertitle/... \ No newline at end of file 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 8a33c8eff1..ee81362d66 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.icon/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.icon/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.icon/... \ No newline at end of file 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 432b880bbf..d98a9d3cf6 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.input/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.input/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.input/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.input/... \ No newline at end of file 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 4b9552e05a..d71114d7d1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.kubeeventdetails/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.kubeeventdetails/... \ No newline at end of file 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 4f2bc0316a..0c9d385119 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/... \ No newline at end of file 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 25604adec6..b243e57617 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/... \ No newline at end of file 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 c97180d896..8e12008f7b 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/... \ No newline at end of file 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 223d94f2e1..4d6683a9c6 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/... \ No newline at end of file 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 2224aaa5ef..071caf12a8 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.lineprogress/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.lineprogress/... \ No newline at end of file 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 2f6af77a66..58d7b7cd9b 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menu/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.menu/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.menu/... \ No newline at end of file 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 332df05435..d7316d769a 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.menuactions/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.menuactions/... \ No newline at end of file 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 5a094531d1..2113e30601 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.menuitem/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.menuitem/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html b/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html index 7e00268283..ce7783fb61 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.namespaceselect/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.namespaceselect/... \ 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 82b7b7713b..fa5f283cf0 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.notifications/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.notifications/... \ No newline at end of file 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 a308cec2c2..b87be8b6c0 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.notificationsstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.notificationsstore/... \ No newline at end of file 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 e12058e7e0..3553c2752c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.pagelayout/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.pagelayout/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html b/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html index 6f73df37a4..a1161f9377 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.poddetailslist/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.poddetailslist/... \ 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 5b42fbef75..12d87eaf2c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.radio/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.radio/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.radio/... \ No newline at end of file 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 ec74e903c3..a97b50686c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.radiogroup/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.radiogroup/... \ No newline at end of file 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 6bef8644c0..8c9e0077d0 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.select/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.select/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.select/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.select/... \ No newline at end of file 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 b1887e224b..de5e137482 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.slider/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.slider/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.slider/... \ No newline at end of file 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 dfbd56fbeb..386dcd7140 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.spinner/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.spinner/... \ No newline at end of file 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 d71213b8bf..d312b2eaab 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.statusbrick/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.statusbrick/... \ No newline at end of file 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 064b382b72..4426f42747 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.stepper/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.stepper/... \ No newline at end of file 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 2b98fdff22..b9ba12147b 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tab/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.tab/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.tab/... \ No newline at end of file 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 5be4b6e57b..137272f3e6 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.table/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.table/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.table/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.table/... \ No newline at end of file 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 6d3fa4945a..87a4915887 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.tablecell/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.tablecell/... \ No newline at end of file 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 8bdbff1ab7..e936f635a4 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.tablehead/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.tablehead/... \ No newline at end of file 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 0f0a4bd6f7..a2c15bd723 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.tablerow/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.tablerow/... \ No newline at end of file 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 d4168fd479..75f0c9f48d 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.tabs/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.tabs/... \ No newline at end of file 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 8c3be72557..70c8026927 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.tooltip/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.tooltip/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html b/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html index 14970bab15..e611e3cce0 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.wizard/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.wizard/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.wizard/... \ 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 083a67034c..b374877c61 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.wizardlayout/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.wizardlayout/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html b/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html index 31dd9d9e23..fa527156a2 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.wizardstep/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_components_.wizardstep/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_components_.wizardstep/... \ 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 ae66de307e..d3a0b20c79 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/... \ No newline at end of file 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 d5c0c10851..e427f16236 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/... \ No newline at end of file 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 45d054f298..64484e49a5 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.configmap/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.configmap/... \ No newline at end of file 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 b7ea2c1071..4e01618668 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/... \ No newline at end of file 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 53a81fbdc4..e3500f17d1 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/... \ No newline at end of file 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 6faa9c3a0a..02469f4d93 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.crdstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.crdstore/... \ No newline at end of file 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 402df2b39f..a3b5da0ea4 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.cronjob/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.cronjob/... \ No newline at end of file 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 4b0d6cb666..d7bff5691e 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/... \ No newline at end of file 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 553aa3dbe0..8593c614e9 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/... \ No newline at end of file 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 d77dd47f99..04c7922f80 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.daemonset/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.daemonset/... \ No newline at end of file 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 937700a5ca..30b27bcb9e 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/... \ No newline at end of file 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 0a57e0ae70..b57172f62e 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.deployment/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deployment/... \ No newline at end of file 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 792e521277..6b38a56c08 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/... \ No newline at end of file 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 9e1d337af9..894357ccd2 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html index fe5c690e37..041228a137 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.endpoint/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.endpoint/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html index 3ac030e405..e4be10af51 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html index d6b260eaa8..d3cfb9bf71 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.eventstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.eventstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html index 9dd34268ab..9f54ce6b0a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html index 27ceb48c2c..492da7b6a0 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.hpastore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.hpastore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html index 4e08a4dc70..258337d34b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.ingress/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingress/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html index e78895ca70..b2e721dafb 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html index 8b246b4442..24fc71eb88 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html index 4711eb99c2..514da752a9 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.job/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.job/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html index 3a7298a92c..1321b988c4 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.jobstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.jobstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html index 13bca08099..95534795f0 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html index a3522c6d74..f708620882 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html index 7ccd19b642..1e3093650f 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html index c686cab8cc..bab3468707 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html index 862e741556..5c071d25e1 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.limitrange/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.limitrange/... \ 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 index 5e996cc561..3385a0ce37 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/... \ 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 1985d00adc..2b4b3b13f9 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.namespace/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.namespace/... \ No newline at end of file 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 2dde427cab..d33d311418 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/... \ No newline at end of file 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 0c804cedae..8ac88584ff 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/... \ No newline at end of file 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 8e937f0e5d..1a4175580a 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/... \ No newline at end of file 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 5c6c6a20f0..82bae9037d 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.node/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.node/... \ No newline at end of file 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 1fc9a37732..1bc2a01bf7 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/... \ No newline at end of file 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 2828e3eecd..527de92fb7 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html index e99415959a..dde9ca4480 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html index 79c88c8462..823b7d5642 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html index f62ebd292b..9d28de5120 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html index 950018f13b..7dda559a77 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html index a0ef8a3dd7..8322a74309 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.pod/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.pod/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html index e136743527..8ea308cda4 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html index 707ae25972..ec6bfec2dd 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html index a235ea4cfc..62fd50c2af 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.podsapi/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.podsapi/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html index 1a3d83188a..738a5bde38 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.podsstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.podsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html index 97145964e7..d226ca3118 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.replicaset/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.replicaset/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html index aad14d8839..e23c8b8532 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html index 5302cabefc..60f2f15975 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html index 091fe23bf3..60f21f58f2 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html index d8d0147876..5c37de5414 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.role/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.role/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html index f57a8e3074..58bd606c60 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html index a6da05eee1..e95673e38e 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html index d518d149e3..4c57a77560 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html index e3c5c43f4a..d8989035c2 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.secret/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.secret/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html index 2c29dd0470..c0075bc971 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html index 7592f156d8..20da7c2dea 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.service/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.service/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html index 610e93d720..d5e052d329 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html index b482f5ef1f..4fcdd8d936 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html index c4fd4481e3..b76a36b0ad 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.servicestore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.servicestore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html index 0c5978c092..f6c087feed 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.statefulset/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.statefulset/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html index ef5b370789..7e55a60bcc 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html index 76a4390d1e..8b6ffd61d9 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.storageclass/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.storageclass/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html index b949f8d85c..d3f54fdfda 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html index ef8d8e56d1..d4654e1dc4 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/... \ No newline at end of file diff --git a/latest/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html b/latest/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html index 6b1940ae05..455527b246 100644 --- a/latest/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html +++ b/latest/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/_renderer_api_navigation_.pageparam/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/_renderer_api_navigation_.pageparam/... \ 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 fcb79bccab..88097a82d4 100644 --- a/latest/extensions/api/classes/lensmainextension/index.html +++ b/latest/extensions/api/classes/lensmainextension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/lensmainextension/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/lensmainextension/... \ No newline at end of file diff --git a/latest/extensions/api/classes/lensrendererextension/index.html b/latest/extensions/api/classes/lensrendererextension/index.html index d28b22e6c7..e87e0d149e 100644 --- a/latest/extensions/api/classes/lensrendererextension/index.html +++ b/latest/extensions/api/classes/lensrendererextension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/classes/lensrendererextension/... + Redirecting to ../../../../../v4.2.5/extensions/api/classes/lensrendererextension/... \ No newline at end of file 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 93d8216e43..3ff2e4a67b 100644 --- a/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html +++ b/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/enums/_renderer_api_components_.notificationstatus/... + Redirecting to ../../../../../v4.2.5/extensions/api/enums/_renderer_api_components_.notificationstatus/... \ No newline at end of file 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 d3091d3489..489be3f5a7 100644 --- a/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html +++ b/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/enums/_renderer_api_components_.tooltipposition/... + Redirecting to ../../../../../v4.2.5/extensions/api/enums/_renderer_api_components_.tooltipposition/... \ No newline at end of file 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 a349e88588..39ac4170b6 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/... + Redirecting to ../../../../../v4.2.5/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/... \ No newline at end of file diff --git a/latest/extensions/api/globals/index.html b/latest/extensions/api/globals/index.html index 3526d06b54..6e189d57e4 100644 --- a/latest/extensions/api/globals/index.html +++ b/latest/extensions/api/globals/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/api/globals/... + Redirecting to ../../../../v4.2.5/extensions/api/globals/... \ No newline at end of file diff --git a/latest/extensions/api/index.html b/latest/extensions/api/index.html index a2271c48a5..dcb9d4d5ca 100644 --- a/latest/extensions/api/index.html +++ b/latest/extensions/api/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v4.2.4/extensions/api/... + Redirecting to ../../../v4.2.5/extensions/api/... \ No newline at end of file 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 7c9b32ce06..b561e81249 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/... \ No newline at end of file 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 4d8140de43..571a1dc191 100644 --- a/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html +++ b/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_core_api_stores_.clustermodel/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_core_api_stores_.clustermodel/... \ No newline at end of file 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 4bdb4592b0..2524b7edb2 100644 --- a/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html +++ b/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_core_api_stores_.workspacemodel/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_core_api_stores_.workspacemodel/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html index 0a6be1e42f..51263645a6 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html index 2be9232fd1..a8034eb49a 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html index 6dc48ebe8d..24ff4c203f 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html index 80903d68a9..c218ac38e3 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html index 8eb27e466a..a96e04bea4 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/... \ 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 ee8669da1e..96f8eb831c 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html index 863ddf2948..c02cebf394 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html index e5e372fe45..bb48c84af5 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html index 50ca24bd69..e65da25efd 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html index 3338ac1c0b..1b37c5de1b 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html index fa5f7e37b5..94de97f9da 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/... \ 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 8d5a853d05..b1e817d03a 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.pagecomponents/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.pagecomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html index ffa7086d71..8b4c473bd5 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html index d9b817d80d..2d59fe72d4 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pageparams/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pageparams/index.html index 77129e4d31..d2ab5152cd 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pageparams/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pageparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.pageparams/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.pageparams/... \ 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 aa2303ff54..1d93f47083 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.pageregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.pageregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html index bde8e7800b..33cc312bc9 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.pagetarget/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.pagetarget/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html index e123eb8ee3..cad895d6b3 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/... \ 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 index 782d96fd63..a9101735c0 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.registeredpage/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.registeredpage/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.routehandler/index.html b/latest/extensions/api/interfaces/_interfaces_index_.routehandler/index.html index 5652bc2e6e..cc491ea21c 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.routehandler/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.routehandler/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.routehandler/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.routehandler/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_interfaces_index_.routeparams/index.html b/latest/extensions/api/interfaces/_interfaces_index_.routeparams/index.html index a16f1418b4..3fcf86a351 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.routeparams/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.routeparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.routeparams/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.routeparams/... \ 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 6a6fa9f6ca..33d9ac4980 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_interfaces_index_.statusbarregistration/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_interfaces_index_.statusbarregistration/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html index 3228c5d8ed..3c6feb8549 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.badgeprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.badgeprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html index 075927d259..cad70bbe21 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.buttonprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.buttonprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html index 690939dfe1..1fc7c0f20a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.checkboxprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.checkboxprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/index.html index 558901b522..b6082375f6 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/... \ No newline at end of file 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 ae27b3dc48..b13b8b135e 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/... \ No newline at end of file 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 61eb27ac92..0fa3cdf350 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/... \ No newline at end of file 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 fdee1263d0..f73734a9a7 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/... \ No newline at end of file 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 48ce5284ce..bd7b124e0c 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.dialogprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.dialogprops/... \ No newline at end of file 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 995aeebe36..18204dcc89 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/... \ No newline at end of file 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 c08c11ed62..aad4b5e97c 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.draweritemprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.draweritemprops/... \ No newline at end of file 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 e225670398..82bed0b9b6 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/... \ No newline at end of file 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 02a9e64c1c..d6cfefb553 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.drawerprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawerprops/... \ No newline at end of file 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 0b9f332539..0d18ddc975 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/... \ No newline at end of file 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 616ad98a25..1d3e0749eb 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.groupselectoption/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.groupselectoption/... \ No newline at end of file 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 5ab1991f43..4294c4a072 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.iconprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.iconprops/... \ No newline at end of file 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 caaac06302..356c9beb2f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.inputvalidator/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.inputvalidator/... \ No newline at end of file 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 f33e186e23..70f1a9e3d3 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/... \ No newline at end of file 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 5d1960a3c4..5ba49de4b3 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/... \ No newline at end of file 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 dfa91a65a3..f3b444c273 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/... \ No newline at end of file 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 1dea6cce3d..7b0c6ac5ab 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html index d3cea465d9..1a28459f62 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html index 8717bb3404..2074f1ca5e 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html index adbbc74a11..aa9aacefe4 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html index 21811f31a6..4adb4b5cad 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.menuitemprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuitemprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html index 71eb6baca1..12a866d21e 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.menuposition/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuposition/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html index b4e7edf4e0..43702f197a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.menuprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.notification/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.notification/index.html index ade917bc7a..bedc2eaf62 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.notification/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.notification/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.notification/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.notification/... \ No newline at end of file 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 a6eb63dfb8..c5dc405fa6 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/... \ No newline at end of file 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 77b5461a65..f37749c036 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/... \ No newline at end of file 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 ef7a2ac7a7..9c72a6b6c3 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.selectoption/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.selectoption/... \ No newline at end of file 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 d2760089f9..8fb7852673 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.selectprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.selectprops/... \ No newline at end of file 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 6cd44d2b9c..762e177812 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.sliderprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.sliderprops/... \ No newline at end of file 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 82af83c812..bb2403e3e4 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.spinnerprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.spinnerprops/... \ No newline at end of file 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 8b8c9be654..7255ec786b 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/... \ No newline at end of file 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 5e2040bacc..ddd231583f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.stepperprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.stepperprops/... \ No newline at end of file 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 26b4faa447..4ad95bf415 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/... \ No newline at end of file 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 3509705d2d..ee40c49ee7 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/... \ No newline at end of file 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 8faaed733d..db6212a851 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tablecellprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablecellprops/... \ No newline at end of file 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 352dd62138..1b3d07e2eb 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tableheadprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tableheadprops/... \ No newline at end of file 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 d86f1d51b1..8f8b7d3b0a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tableprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tableprops/... \ No newline at end of file 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 ecdbb3b0ae..850d7b45ad 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tablerowprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablerowprops/... \ No newline at end of file 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 f919d37bef..c5dcd3f287 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tabprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tabprops/... \ No newline at end of file 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 5c9a7cf9e3..f7f848899a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tabsprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tabsprops/... \ No newline at end of file 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 e733abb195..0a4746dd4a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/... \ No newline at end of file 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 16d014750d..ae88b2f1bc 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/... \ No newline at end of file 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 b3d460e365..7407be6525 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.tooltipprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipprops/... \ No newline at end of file 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 1032b88eb2..a31e548c7b 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html index 34ab823fe4..f439664f92 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.wizardprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardprops/... \ 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 index 41cf4f4f1b..5707d4ab92 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/... \ 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 ba715a853a..2b7e5bac9d 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/... \ No newline at end of file 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 c429e47bd9..16525ae081 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/... \ No newline at end of file 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 d02ef1c1f6..00b1f1aed2 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/... \ No newline at end of file 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 5bac798e9d..51c76d5bfa 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 @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/... \ No newline at end of file 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 7df392ffd2..268a54a97e 100644 --- a/latest/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/... \ No newline at end of file diff --git a/latest/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html b/latest/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html index 2420f9bbb6..4b9fbaeae5 100644 --- a/latest/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/... + Redirecting to ../../../../../v4.2.5/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/... \ 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 5ed9b3f3a5..7f85c17779 100644 --- a/latest/extensions/api/modules/_core_api_app_/index.html +++ b/latest/extensions/api/modules/_core_api_app_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_core_api_app_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_core_api_app_/... \ No newline at end of file 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 ce27fd43f0..dae506df3b 100644 --- a/latest/extensions/api/modules/_core_api_cluster_feature_/index.html +++ b/latest/extensions/api/modules/_core_api_cluster_feature_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_core_api_cluster_feature_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_core_api_cluster_feature_/... \ No newline at end of file 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 8f40fa49aa..b9348d0a5a 100644 --- a/latest/extensions/api/modules/_core_api_event_bus_/index.html +++ b/latest/extensions/api/modules/_core_api_event_bus_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_core_api_event_bus_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_core_api_event_bus_/... \ No newline at end of file diff --git a/latest/extensions/api/modules/_core_api_stores_/index.html b/latest/extensions/api/modules/_core_api_stores_/index.html index 0afb71409e..3b9a7efdd8 100644 --- a/latest/extensions/api/modules/_core_api_stores_/index.html +++ b/latest/extensions/api/modules/_core_api_stores_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_core_api_stores_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_core_api_stores_/... \ No newline at end of file diff --git a/latest/extensions/api/modules/_core_api_utils_/index.html b/latest/extensions/api/modules/_core_api_utils_/index.html index 8164a4c2b7..875ee3ef3d 100644 --- a/latest/extensions/api/modules/_core_api_utils_/index.html +++ b/latest/extensions/api/modules/_core_api_utils_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_core_api_utils_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_core_api_utils_/... \ No newline at end of file diff --git a/latest/extensions/api/modules/_interfaces_index_/index.html b/latest/extensions/api/modules/_interfaces_index_/index.html index b1fc5b80df..0c1080d2a7 100644 --- a/latest/extensions/api/modules/_interfaces_index_/index.html +++ b/latest/extensions/api/modules/_interfaces_index_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_interfaces_index_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_interfaces_index_/... \ No newline at end of file diff --git a/latest/extensions/api/modules/_renderer_api_components_/index.html b/latest/extensions/api/modules/_renderer_api_components_/index.html index b46f1ed5bb..bddbf88351 100644 --- a/latest/extensions/api/modules/_renderer_api_components_/index.html +++ b/latest/extensions/api/modules/_renderer_api_components_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_renderer_api_components_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_renderer_api_components_/... \ No newline at end of file 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 85d80eb1e2..c8c8d35cdb 100644 --- a/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html +++ b/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_renderer_api_k8s_api_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_renderer_api_k8s_api_/... \ No newline at end of file diff --git a/latest/extensions/api/modules/_renderer_api_navigation_/index.html b/latest/extensions/api/modules/_renderer_api_navigation_/index.html index 0542591486..42ed9eb0c8 100644 --- a/latest/extensions/api/modules/_renderer_api_navigation_/index.html +++ b/latest/extensions/api/modules/_renderer_api_navigation_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_renderer_api_navigation_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_renderer_api_navigation_/... \ No newline at end of file diff --git a/latest/extensions/api/modules/_renderer_api_theming_/index.html b/latest/extensions/api/modules/_renderer_api_theming_/index.html index a345c27131..10be8e19ab 100644 --- a/latest/extensions/api/modules/_renderer_api_theming_/index.html +++ b/latest/extensions/api/modules/_renderer_api_theming_/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../../v4.2.4/extensions/api/modules/_renderer_api_theming_/... + Redirecting to ../../../../../v4.2.5/extensions/api/modules/_renderer_api_theming_/... \ No newline at end of file diff --git a/latest/extensions/capabilities/color-reference/index.html b/latest/extensions/capabilities/color-reference/index.html index 7f55af7c3c..0b5bd32c24 100644 --- a/latest/extensions/capabilities/color-reference/index.html +++ b/latest/extensions/capabilities/color-reference/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/capabilities/color-reference/... + Redirecting to ../../../../v4.2.5/extensions/capabilities/color-reference/... \ No newline at end of file diff --git a/latest/extensions/capabilities/common-capabilities/index.html b/latest/extensions/capabilities/common-capabilities/index.html index c453a56052..f0ffdc8535 100644 --- a/latest/extensions/capabilities/common-capabilities/index.html +++ b/latest/extensions/capabilities/common-capabilities/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/capabilities/common-capabilities/... + Redirecting to ../../../../v4.2.5/extensions/capabilities/common-capabilities/... \ No newline at end of file diff --git a/latest/extensions/capabilities/index.html b/latest/extensions/capabilities/index.html index 7b3dd7ae08..140e3d5368 100644 --- a/latest/extensions/capabilities/index.html +++ b/latest/extensions/capabilities/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v4.2.4/extensions/capabilities/... + Redirecting to ../../../v4.2.5/extensions/capabilities/... \ No newline at end of file diff --git a/latest/extensions/capabilities/styling/index.html b/latest/extensions/capabilities/styling/index.html index de10d71a14..b95bf161c1 100644 --- a/latest/extensions/capabilities/styling/index.html +++ b/latest/extensions/capabilities/styling/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/capabilities/styling/... + Redirecting to ../../../../v4.2.5/extensions/capabilities/styling/... \ No newline at end of file diff --git a/latest/extensions/get-started/anatomy/index.html b/latest/extensions/get-started/anatomy/index.html index 4809f8b83a..3d8088fb46 100644 --- a/latest/extensions/get-started/anatomy/index.html +++ b/latest/extensions/get-started/anatomy/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/get-started/anatomy/... + Redirecting to ../../../../v4.2.5/extensions/get-started/anatomy/... \ No newline at end of file diff --git a/latest/extensions/get-started/overview/index.html b/latest/extensions/get-started/overview/index.html index 9e159a410f..95ae68a230 100644 --- a/latest/extensions/get-started/overview/index.html +++ b/latest/extensions/get-started/overview/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/get-started/overview/... + Redirecting to ../../../../v4.2.5/extensions/get-started/overview/... \ No newline at end of file diff --git a/latest/extensions/get-started/wrapping-up/index.html b/latest/extensions/get-started/wrapping-up/index.html index df027d538b..f353cc2250 100644 --- a/latest/extensions/get-started/wrapping-up/index.html +++ b/latest/extensions/get-started/wrapping-up/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/get-started/wrapping-up/... + Redirecting to ../../../../v4.2.5/extensions/get-started/wrapping-up/... \ No newline at end of file diff --git a/latest/extensions/get-started/your-first-extension/index.html b/latest/extensions/get-started/your-first-extension/index.html index 74545ff658..34d419bf40 100644 --- a/latest/extensions/get-started/your-first-extension/index.html +++ b/latest/extensions/get-started/your-first-extension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/get-started/your-first-extension/... + Redirecting to ../../../../v4.2.5/extensions/get-started/your-first-extension/... \ No newline at end of file diff --git a/latest/extensions/guides/anatomy/index.html b/latest/extensions/guides/anatomy/index.html index adf47e8139..af25f149b1 100644 --- a/latest/extensions/guides/anatomy/index.html +++ b/latest/extensions/guides/anatomy/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/anatomy/... + Redirecting to ../../../../v4.2.5/extensions/guides/anatomy/... \ No newline at end of file diff --git a/latest/extensions/guides/components/index.html b/latest/extensions/guides/components/index.html index a2e31f6da4..0d7547c78f 100644 --- a/latest/extensions/guides/components/index.html +++ b/latest/extensions/guides/components/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/components/... + Redirecting to ../../../../v4.2.5/extensions/guides/components/... \ No newline at end of file diff --git a/latest/extensions/guides/generator/index.html b/latest/extensions/guides/generator/index.html index 92b4390fca..ee9ec2e8c6 100644 --- a/latest/extensions/guides/generator/index.html +++ b/latest/extensions/guides/generator/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/generator/... + Redirecting to ../../../../v4.2.5/extensions/guides/generator/... \ No newline at end of file diff --git a/latest/extensions/guides/index.html b/latest/extensions/guides/index.html index d859751135..df82a7011f 100644 --- a/latest/extensions/guides/index.html +++ b/latest/extensions/guides/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v4.2.4/extensions/guides/... + Redirecting to ../../../v4.2.5/extensions/guides/... \ No newline at end of file diff --git a/latest/extensions/guides/kube-object-list-layout/index.html b/latest/extensions/guides/kube-object-list-layout/index.html index df08a88a38..56e878775a 100644 --- a/latest/extensions/guides/kube-object-list-layout/index.html +++ b/latest/extensions/guides/kube-object-list-layout/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/kube-object-list-layout/... + Redirecting to ../../../../v4.2.5/extensions/guides/kube-object-list-layout/... \ No newline at end of file diff --git a/latest/extensions/guides/main-extension/index.html b/latest/extensions/guides/main-extension/index.html index f840b4ae7e..c6676b35ce 100644 --- a/latest/extensions/guides/main-extension/index.html +++ b/latest/extensions/guides/main-extension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/main-extension/... + Redirecting to ../../../../v4.2.5/extensions/guides/main-extension/... \ No newline at end of file diff --git a/latest/extensions/guides/protocol-handlers/index.html b/latest/extensions/guides/protocol-handlers/index.html index aa59c02bdf..b2e994be69 100644 --- a/latest/extensions/guides/protocol-handlers/index.html +++ b/latest/extensions/guides/protocol-handlers/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/protocol-handlers/... + Redirecting to ../../../../v4.2.5/extensions/guides/protocol-handlers/... \ No newline at end of file diff --git a/latest/extensions/guides/renderer-extension/index.html b/latest/extensions/guides/renderer-extension/index.html index cbaebd2809..18bc4e3044 100644 --- a/latest/extensions/guides/renderer-extension/index.html +++ b/latest/extensions/guides/renderer-extension/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/renderer-extension/... + Redirecting to ../../../../v4.2.5/extensions/guides/renderer-extension/... \ No newline at end of file diff --git a/latest/extensions/guides/stores/index.html b/latest/extensions/guides/stores/index.html index a33a5decdc..3043628ac2 100644 --- a/latest/extensions/guides/stores/index.html +++ b/latest/extensions/guides/stores/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/stores/... + Redirecting to ../../../../v4.2.5/extensions/guides/stores/... \ No newline at end of file diff --git a/latest/extensions/guides/working-with-mobx/index.html b/latest/extensions/guides/working-with-mobx/index.html index d003ff1081..f9d640d309 100644 --- a/latest/extensions/guides/working-with-mobx/index.html +++ b/latest/extensions/guides/working-with-mobx/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/guides/working-with-mobx/... + Redirecting to ../../../../v4.2.5/extensions/guides/working-with-mobx/... \ No newline at end of file diff --git a/latest/extensions/index.html b/latest/extensions/index.html index 84f31259cc..959b59f883 100644 --- a/latest/extensions/index.html +++ b/latest/extensions/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../v4.2.4/extensions/... + Redirecting to ../../v4.2.5/extensions/... \ No newline at end of file diff --git a/latest/extensions/testing-and-publishing/bundling/index.html b/latest/extensions/testing-and-publishing/bundling/index.html index 0f14fcffc8..de0c3e0d6f 100644 --- a/latest/extensions/testing-and-publishing/bundling/index.html +++ b/latest/extensions/testing-and-publishing/bundling/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/testing-and-publishing/bundling/... + Redirecting to ../../../../v4.2.5/extensions/testing-and-publishing/bundling/... \ No newline at end of file diff --git a/latest/extensions/testing-and-publishing/publishing/index.html b/latest/extensions/testing-and-publishing/publishing/index.html index ee53fabe3b..c1e91809eb 100644 --- a/latest/extensions/testing-and-publishing/publishing/index.html +++ b/latest/extensions/testing-and-publishing/publishing/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/testing-and-publishing/publishing/... + Redirecting to ../../../../v4.2.5/extensions/testing-and-publishing/publishing/... \ No newline at end of file diff --git a/latest/extensions/testing-and-publishing/testing/index.html b/latest/extensions/testing-and-publishing/testing/index.html index 53f78730fe..e922f99ab9 100644 --- a/latest/extensions/testing-and-publishing/testing/index.html +++ b/latest/extensions/testing-and-publishing/testing/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../../v4.2.4/extensions/testing-and-publishing/testing/... + Redirecting to ../../../../v4.2.5/extensions/testing-and-publishing/testing/... \ No newline at end of file diff --git a/latest/extensions/usage/index.html b/latest/extensions/usage/index.html index 8c736af2f4..d711586fa3 100644 --- a/latest/extensions/usage/index.html +++ b/latest/extensions/usage/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../../../v4.2.4/extensions/usage/... + Redirecting to ../../../v4.2.5/extensions/usage/... \ No newline at end of file diff --git a/latest/faq/index.html b/latest/faq/index.html new file mode 100644 index 0000000000..6ef78565b1 --- /dev/null +++ b/latest/faq/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../v4.2.5/faq/... + + \ No newline at end of file diff --git a/latest/getting-started/index.html b/latest/getting-started/index.html new file mode 100644 index 0000000000..67aed3ece6 --- /dev/null +++ b/latest/getting-started/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../v4.2.5/getting-started/... + + \ No newline at end of file diff --git a/latest/getting-started/introductory-videos/index.html b/latest/getting-started/introductory-videos/index.html new file mode 100644 index 0000000000..bb48dc14e3 --- /dev/null +++ b/latest/getting-started/introductory-videos/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/getting-started/introductory-videos/... + + \ No newline at end of file diff --git a/latest/getting-started/preferences/index.html b/latest/getting-started/preferences/index.html new file mode 100644 index 0000000000..91b7c59520 --- /dev/null +++ b/latest/getting-started/preferences/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/getting-started/preferences/... + + \ No newline at end of file diff --git a/latest/helm/index.html b/latest/helm/index.html new file mode 100644 index 0000000000..188254fa59 --- /dev/null +++ b/latest/helm/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../v4.2.5/helm/... + + \ No newline at end of file diff --git a/latest/index.html b/latest/index.html index edeb087622..01f8264738 100644 --- a/latest/index.html +++ b/latest/index.html @@ -4,13 +4,13 @@ Redirecting - Redirecting to ../v4.2.4/... + Redirecting to ../v4.2.5/... \ No newline at end of file diff --git a/latest/support/index.html b/latest/support/index.html new file mode 100644 index 0000000000..3db8a7536b --- /dev/null +++ b/latest/support/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../v4.2.5/support/... + + \ No newline at end of file diff --git a/latest/supporting/requirements/index.html b/latest/supporting/requirements/index.html new file mode 100644 index 0000000000..f807327473 --- /dev/null +++ b/latest/supporting/requirements/index.html @@ -0,0 +1,16 @@ + + + + + Redirecting + + + + + Redirecting to ../../../v4.2.5/supporting/requirements/... + + \ No newline at end of file diff --git a/v4.2.5/404.html b/v4.2.5/404.html new file mode 100644 index 0000000000..2ae1026187 --- /dev/null +++ b/v4.2.5/404.html @@ -0,0 +1,1026 @@ + + + + + + + + + + + + + + + + + + + + + + + + Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+ +

404 - Not found

+ + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/CNAME b/v4.2.5/CNAME new file mode 100644 index 0000000000..12bc650410 --- /dev/null +++ b/v4.2.5/CNAME @@ -0,0 +1 @@ +docs.k8slens.dev diff --git a/v4.2.5/assets/images/favicon.png b/v4.2.5/assets/images/favicon.png new file mode 100644 index 0000000000..1cf13b9f9d Binary files /dev/null and b/v4.2.5/assets/images/favicon.png differ diff --git a/v4.2.5/assets/javascripts/bundle.82217815.min.js b/v4.2.5/assets/javascripts/bundle.82217815.min.js new file mode 100644 index 0000000000..f79dc267e1 --- /dev/null +++ b/v4.2.5/assets/javascripts/bundle.82217815.min.js @@ -0,0 +1,108 @@ +(()=>{var oa=Object.create,St=Object.defineProperty;var na=Object.getOwnPropertyDescriptor;var ia=Object.getOwnPropertyNames,wt=Object.getOwnPropertySymbols,aa=Object.getPrototypeOf,ar=Object.prototype.hasOwnProperty,Kr=Object.prototype.propertyIsEnumerable;var Br=(e,t,r)=>t in e?St(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,R=(e,t)=>{for(var r in t||(t={}))ar.call(t,r)&&Br(e,r,t[r]);if(wt)for(var r of wt(t))Kr.call(t,r)&&Br(e,r,t[r]);return e};var sa=e=>St(e,"__esModule",{value:!0});var Yr=(e,t)=>{var r={};for(var o in e)ar.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&wt)for(var o of wt(e))t.indexOf(o)<0&&Kr.call(e,o)&&(r[o]=e[o]);return r};var Et=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var ca=(e,t,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of ia(t))!ar.call(e,o)&&o!=="default"&&St(e,o,{get:()=>t[o],enumerable:!(r=na(t,o))||r.enumerable});return e},ct=e=>ca(sa(St(e!=null?oa(aa(e)):{},"default",e&&e.__esModule&&"default"in e?{get:()=>e.default,enumerable:!0}:{value:e,enumerable:!0})),e);var Jr=Et((sr,Gr)=>{(function(e,t){typeof sr=="object"&&typeof Gr!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(sr,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(T){return!!(T&&T!==document&&T.nodeName!=="HTML"&&T.nodeName!=="BODY"&&"classList"in T&&"contains"in T.classList)}function c(T){var De=T.type,_e=T.tagName;return!!(_e==="INPUT"&&a[De]&&!T.readOnly||_e==="TEXTAREA"&&!T.readOnly||T.isContentEditable)}function l(T){T.classList.contains("focus-visible")||(T.classList.add("focus-visible"),T.setAttribute("data-focus-visible-added",""))}function p(T){!T.hasAttribute("data-focus-visible-added")||(T.classList.remove("focus-visible"),T.removeAttribute("data-focus-visible-added"))}function m(T){T.metaKey||T.altKey||T.ctrlKey||(s(r.activeElement)&&l(r.activeElement),o=!0)}function f(T){o=!1}function d(T){!s(T.target)||(o||c(T.target))&&l(T.target)}function v(T){!s(T.target)||(T.target.classList.contains("focus-visible")||T.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),p(T.target))}function h(T){document.visibilityState==="hidden"&&(n&&(o=!0),U())}function U(){document.addEventListener("mousemove",P),document.addEventListener("mousedown",P),document.addEventListener("mouseup",P),document.addEventListener("pointermove",P),document.addEventListener("pointerdown",P),document.addEventListener("pointerup",P),document.addEventListener("touchmove",P),document.addEventListener("touchstart",P),document.addEventListener("touchend",P)}function Y(){document.removeEventListener("mousemove",P),document.removeEventListener("mousedown",P),document.removeEventListener("mouseup",P),document.removeEventListener("pointermove",P),document.removeEventListener("pointerdown",P),document.removeEventListener("pointerup",P),document.removeEventListener("touchmove",P),document.removeEventListener("touchstart",P),document.removeEventListener("touchend",P)}function P(T){T.target.nodeName&&T.target.nodeName.toLowerCase()==="html"||(o=!1,Y())}document.addEventListener("keydown",m,!0),document.addEventListener("mousedown",f,!0),document.addEventListener("pointerdown",f,!0),document.addEventListener("touchstart",f,!0),document.addEventListener("visibilitychange",h,!0),U(),r.addEventListener("focus",d,!0),r.addEventListener("blur",v,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var xo=Et((hs,_t)=>{var Xr,Zr,eo,to,ro,oo,no,io,ao,Tt,cr,so,co,lo,Be,po,uo,fo,mo,ho,bo,vo,go,Ot;(function(e){var t=typeof global=="object"?global:typeof self=="object"?self:typeof this=="object"?this:{};typeof define=="function"&&define.amd?define("tslib",["exports"],function(o){e(r(t,r(o)))}):typeof _t=="object"&&typeof _t.exports=="object"?e(r(t,r(_t.exports))):e(r(t));function r(o,n){return o!==t&&(typeof Object.create=="function"?Object.defineProperty(o,"__esModule",{value:!0}):o.__esModule=!0),function(i,a){return o[i]=n?n(i,a):a}}})(function(e){var t=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(o,n){o.__proto__=n}||function(o,n){for(var i in n)Object.prototype.hasOwnProperty.call(n,i)&&(o[i]=n[i])};Xr=function(o,n){if(typeof n!="function"&&n!==null)throw new TypeError("Class extends value "+String(n)+" is not a constructor or null");t(o,n);function i(){this.constructor=o}o.prototype=n===null?Object.create(n):(i.prototype=n.prototype,new i)},Zr=Object.assign||function(o){for(var n,i=1,a=arguments.length;i=0;p--)(l=o[p])&&(c=(s<3?l(c):s>3?l(n,i,c):l(n,i))||c);return s>3&&c&&Object.defineProperty(n,i,c),c},ro=function(o,n){return function(i,a){n(i,a,o)}},oo=function(o,n){if(typeof Reflect=="object"&&typeof Reflect.metadata=="function")return Reflect.metadata(o,n)},no=function(o,n,i,a){function s(c){return c instanceof i?c:new i(function(l){l(c)})}return new(i||(i=Promise))(function(c,l){function p(d){try{f(a.next(d))}catch(v){l(v)}}function m(d){try{f(a.throw(d))}catch(v){l(v)}}function f(d){d.done?c(d.value):s(d.value).then(p,m)}f((a=a.apply(o,n||[])).next())})},io=function(o,n){var i={label:0,sent:function(){if(c[0]&1)throw c[1];return c[1]},trys:[],ops:[]},a,s,c,l;return l={next:p(0),throw:p(1),return:p(2)},typeof Symbol=="function"&&(l[Symbol.iterator]=function(){return this}),l;function p(f){return function(d){return m([f,d])}}function m(f){if(a)throw new TypeError("Generator is already executing.");for(;i;)try{if(a=1,s&&(c=f[0]&2?s.return:f[0]?s.throw||((c=s.return)&&c.call(s),0):s.next)&&!(c=c.call(s,f[1])).done)return c;switch(s=0,c&&(f=[f[0]&2,c.value]),f[0]){case 0:case 1:c=f;break;case 4:return i.label++,{value:f[1],done:!1};case 5:i.label++,s=f[1],f=[0];continue;case 7:f=i.ops.pop(),i.trys.pop();continue;default:if(c=i.trys,!(c=c.length>0&&c[c.length-1])&&(f[0]===6||f[0]===2)){i=0;continue}if(f[0]===3&&(!c||f[1]>c[0]&&f[1]=o.length&&(o=void 0),{value:o&&o[a++],done:!o}}};throw new TypeError(n?"Object is not iterable.":"Symbol.iterator is not defined.")},cr=function(o,n){var i=typeof Symbol=="function"&&o[Symbol.iterator];if(!i)return o;var a=i.call(o),s,c=[],l;try{for(;(n===void 0||n-- >0)&&!(s=a.next()).done;)c.push(s.value)}catch(p){l={error:p}}finally{try{s&&!s.done&&(i=a.return)&&i.call(a)}finally{if(l)throw l.error}}return c},so=function(){for(var o=[],n=0;n1||p(h,U)})})}function p(h,U){try{m(a[h](U))}catch(Y){v(c[0][3],Y)}}function m(h){h.value instanceof Be?Promise.resolve(h.value.v).then(f,d):v(c[0][2],h)}function f(h){p("next",h)}function d(h){p("throw",h)}function v(h,U){h(U),c.shift(),c.length&&p(c[0][0],c[0][1])}},uo=function(o){var n,i;return n={},a("next"),a("throw",function(s){throw s}),a("return"),n[Symbol.iterator]=function(){return this},n;function a(s,c){n[s]=o[s]?function(l){return(i=!i)?{value:Be(o[s](l)),done:s==="return"}:c?c(l):l}:c}},fo=function(o){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var n=o[Symbol.asyncIterator],i;return n?n.call(o):(o=typeof Tt=="function"?Tt(o):o[Symbol.iterator](),i={},a("next"),a("throw"),a("return"),i[Symbol.asyncIterator]=function(){return this},i);function a(c){i[c]=o[c]&&function(l){return new Promise(function(p,m){l=o[c](l),s(p,m,l.done,l.value)})}}function s(c,l,p,m){Promise.resolve(m).then(function(f){c({value:f,done:p})},l)}},mo=function(o,n){return Object.defineProperty?Object.defineProperty(o,"raw",{value:n}):o.raw=n,o};var r=Object.create?function(o,n){Object.defineProperty(o,"default",{enumerable:!0,value:n})}:function(o,n){o.default=n};ho=function(o){if(o&&o.__esModule)return o;var n={};if(o!=null)for(var i in o)i!=="default"&&Object.prototype.hasOwnProperty.call(o,i)&&Ot(n,o,i);return r(n,o),n},bo=function(o){return o&&o.__esModule?o:{default:o}},vo=function(o,n){if(!n.has(o))throw new TypeError("attempted to get private field on non-instance");return n.get(o)},go=function(o,n,i){if(!n.has(o))throw new TypeError("attempted to set private field on non-instance");return n.set(o,i),i},e("__extends",Xr),e("__assign",Zr),e("__rest",eo),e("__decorate",to),e("__param",ro),e("__metadata",oo),e("__awaiter",no),e("__generator",io),e("__exportStar",ao),e("__createBinding",Ot),e("__values",Tt),e("__read",cr),e("__spread",so),e("__spreadArrays",co),e("__spreadArray",lo),e("__await",Be),e("__asyncGenerator",po),e("__asyncDelegator",uo),e("__asyncValues",fo),e("__makeTemplateObject",mo),e("__importStar",ho),e("__importDefault",bo),e("__classPrivateFieldGet",vo),e("__classPrivateFieldSet",go)})});var Fr=Et((xt,Rr)=>{(function(t,r){typeof xt=="object"&&typeof Rr=="object"?Rr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof xt=="object"?xt.ClipboardJS=r():t.ClipboardJS=r()})(xt,function(){return function(){var e={134:function(o,n,i){"use strict";i.d(n,{default:function(){return ta}});var a=i(279),s=i.n(a),c=i(370),l=i.n(c),p=i(817),m=i.n(p);function f(A){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?f=function(b){return typeof b}:f=function(b){return b&&typeof Symbol=="function"&&b.constructor===Symbol&&b!==Symbol.prototype?"symbol":typeof b},f(A)}function d(A,g){if(!(A instanceof g))throw new TypeError("Cannot call a class as a function")}function v(A,g){for(var b=0;b0&&arguments[0]!==void 0?arguments[0]:{};this.action=b.action,this.container=b.container,this.emitter=b.emitter,this.target=b.target,this.text=b.text,this.trigger=b.trigger,this.selectedText=""}},{key:"initSelection",value:function(){this.text?this.selectFake():this.target&&this.selectTarget()}},{key:"createFakeElement",value:function(){var b=document.documentElement.getAttribute("dir")==="rtl";this.fakeElem=document.createElement("textarea"),this.fakeElem.style.fontSize="12pt",this.fakeElem.style.border="0",this.fakeElem.style.padding="0",this.fakeElem.style.margin="0",this.fakeElem.style.position="absolute",this.fakeElem.style[b?"right":"left"]="-9999px";var C=window.pageYOffset||document.documentElement.scrollTop;return this.fakeElem.style.top="".concat(C,"px"),this.fakeElem.setAttribute("readonly",""),this.fakeElem.value=this.text,this.fakeElem}},{key:"selectFake",value:function(){var b=this,C=this.createFakeElement();this.fakeHandlerCallback=function(){return b.removeFake()},this.fakeHandler=this.container.addEventListener("click",this.fakeHandlerCallback)||!0,this.container.appendChild(C),this.selectedText=m()(C),this.copyText(),this.removeFake()}},{key:"removeFake",value:function(){this.fakeHandler&&(this.container.removeEventListener("click",this.fakeHandlerCallback),this.fakeHandler=null,this.fakeHandlerCallback=null),this.fakeElem&&(this.container.removeChild(this.fakeElem),this.fakeElem=null)}},{key:"selectTarget",value:function(){this.selectedText=m()(this.target),this.copyText()}},{key:"copyText",value:function(){var b;try{b=document.execCommand(this.action)}catch(C){b=!1}this.handleResult(b)}},{key:"handleResult",value:function(b){this.emitter.emit(b?"success":"error",{action:this.action,text:this.selectedText,trigger:this.trigger,clearSelection:this.clearSelection.bind(this)})}},{key:"clearSelection",value:function(){this.trigger&&this.trigger.focus(),document.activeElement.blur(),window.getSelection().removeAllRanges()}},{key:"destroy",value:function(){this.removeFake()}},{key:"action",set:function(){var b=arguments.length>0&&arguments[0]!==void 0?arguments[0]:"copy";if(this._action=b,this._action!=="copy"&&this._action!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"')},get:function(){return this._action}},{key:"target",set:function(b){if(b!==void 0)if(b&&f(b)==="object"&&b.nodeType===1){if(this.action==="copy"&&b.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(this.action==="cut"&&(b.hasAttribute("readonly")||b.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`);this._target=b}else throw new Error('Invalid "target" value, use a valid Element')},get:function(){return this._target}}]),A}(),Y=U;function P(A){return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?P=function(b){return typeof b}:P=function(b){return b&&typeof Symbol=="function"&&b.constructor===Symbol&&b!==Symbol.prototype?"symbol":typeof b},P(A)}function T(A,g){if(!(A instanceof g))throw new TypeError("Cannot call a class as a function")}function De(A,g){for(var b=0;b0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof W.action=="function"?W.action:this.defaultAction,this.target=typeof W.target=="function"?W.target:this.defaultTarget,this.text=typeof W.text=="function"?W.text:this.defaultText,this.container=P(W.container)==="object"?W.container:document.body}},{key:"listenClick",value:function(W){var re=this;this.listener=l()(W,"click",function(st){return re.onClick(st)})}},{key:"onClick",value:function(W){var re=W.delegateTarget||W.currentTarget;this.clipboardAction&&(this.clipboardAction=null),this.clipboardAction=new Y({action:this.action(re),target:this.target(re),text:this.text(re),container:this.container,trigger:re,emitter:this})}},{key:"defaultAction",value:function(W){return ir("action",W)}},{key:"defaultTarget",value:function(W){var re=ir("target",W);if(re)return document.querySelector(re)}},{key:"defaultText",value:function(W){return ir("text",W)}},{key:"destroy",value:function(){this.listener.destroy(),this.clipboardAction&&(this.clipboardAction.destroy(),this.clipboardAction=null)}}],[{key:"isSupported",value:function(){var W=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],re=typeof W=="string"?[W]:W,st=!!document.queryCommandSupported;return re.forEach(function(ra){st=st&&!!document.queryCommandSupported(ra)}),st}}]),b}(s()),ta=ea},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,c){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(c))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(p,m,f,d,v){var h=l.apply(this,arguments);return p.addEventListener(f,h,v),{destroy:function(){p.removeEventListener(f,h,v)}}}function c(p,m,f,d,v){return typeof p.addEventListener=="function"?s.apply(null,arguments):typeof f=="function"?s.bind(null,document).apply(null,arguments):(typeof p=="string"&&(p=document.querySelectorAll(p)),Array.prototype.map.call(p,function(h){return s(h,m,f,d,v)}))}function l(p,m,f,d){return function(v){v.delegateTarget=a(v.target,m),v.delegateTarget&&d.call(p,v)}}o.exports=c},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function c(f,d,v){if(!f&&!d&&!v)throw new Error("Missing required arguments");if(!a.string(d))throw new TypeError("Second argument must be a String");if(!a.fn(v))throw new TypeError("Third argument must be a Function");if(a.node(f))return l(f,d,v);if(a.nodeList(f))return p(f,d,v);if(a.string(f))return m(f,d,v);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function l(f,d,v){return f.addEventListener(d,v),{destroy:function(){f.removeEventListener(d,v)}}}function p(f,d,v){return Array.prototype.forEach.call(f,function(h){h.addEventListener(d,v)}),{destroy:function(){Array.prototype.forEach.call(f,function(h){h.removeEventListener(d,v)})}}}function m(f,d,v){return s(document.body,f,d,v)}o.exports=c},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var c=window.getSelection(),l=document.createRange();l.selectNodeContents(i),c.removeAllRanges(),c.addRange(l),a=c.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var c=this.e||(this.e={});return(c[i]||(c[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var c=this;function l(){c.off(i,l),a.apply(s,arguments)}return l._=a,this.on(i,l,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),c=0,l=s.length;for(c;c{"use strict";var Za=/["'&<>]/;wi.exports=es;function es(e){var t=""+e,r=Za.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=o.hasError,i=o.isStopped,a=o.observers;return n||i?lr:(a.push(r),new le(function(){return Me(a,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new k;return r.source=this,r},t.create=function(r,o){return new Ho(r,o)},t}(k);var Ho=function(e){Z(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:lr},t}(O);var ut={now:function(){return(ut.delegate||Date).now()},delegate:void 0};var ft=function(e){Z(t,e);function t(r,o,n){r===void 0&&(r=Infinity),o===void 0&&(o=Infinity),n===void 0&&(n=ut);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===Infinity,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,c=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+c)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),c=0;c0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=Ge.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){if(n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);r.actions.length===0&&(Ge.cancelAnimationFrame(o),r._scheduled=void 0)},t}(jt);var Fo=function(e){Z(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0,this._scheduled=void 0;var o=this.actions,n,i=-1;r=r||o.shift();var a=o.length;do if(n=r.execute(r.state,r.delay))break;while(++i=2,!0))}function se(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new O}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,c=s===void 0?!0:s;return function(l){var p=null,m=null,f=null,d=0,v=!1,h=!1,U=function(){m==null||m.unsubscribe(),m=null},Y=function(){U(),p=f=null,v=h=!1},P=function(){var T=p;Y(),T==null||T.unsubscribe()};return x(function(T,De){d++,!h&&!v&&U();var _e=f=f!=null?f:r();De.add(function(){d--,d===0&&!h&&!v&&(m=_r(P,c))}),_e.subscribe(De),p||(p=new pt({next:function(Ke){return _e.next(Ke)},error:function(Ke){h=!0,U(),m=_r(Y,n,Ke),_e.error(Ke)},complete:function(){v=!0,U(),m=_r(Y,a),_e.complete()}}),we(T).subscribe(p))})(l)}}function _r(e,t){for(var r=[],o=2;ot==="focus"),N(e===Ne()))}var on=new O,Fa=de(()=>M(new ResizeObserver(e=>{for(let t of e)on.next(t)}))).pipe(S(e=>J.pipe(N(e)).pipe(j(()=>e.disconnect()))),te(1));function Se(e){return{width:e.offsetWidth,height:e.offsetHeight}}function vt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function nn(e){let t=e.parentElement;for(;t&&t!==e.offsetParent;){let r=Se(t);if(vt(t).height>r.height)return t;t=t.parentElement}}function Ve(e){return Fa.pipe(_(t=>t.observe(e)),S(t=>on.pipe(L(({target:r})=>r===e),j(()=>t.unobserve(e)),u(()=>Se(e)))),N(Se(e)))}function an(e){return{x:e.scrollLeft,y:e.scrollTop}}function Ia(e){return V(y(e,"scroll"),y(window,"resize")).pipe(u(()=>an(e)),N(an(e)))}function sn(e,t=16){return Ia(e).pipe(u(({y:r})=>{let o=Se(e),n=vt(e);return r>=n.height-o.height-t}),q())}function cn(e){if(e instanceof HTMLInputElement)e.select();else throw new Error("Not implemented")}var Bt={drawer:ae("[data-md-toggle=drawer]"),search:ae("[data-md-toggle=search]")};function ln(e){return Bt[e].checked}function Ue(e,t){Bt[e].checked!==t&&Bt[e].click()}function Yt(e){let t=Bt[e];return y(t,"change").pipe(u(()=>t.checked),N(t.checked))}function Pa(e){switch(e.tagName){case"INPUT":case"SELECT":case"TEXTAREA":return!0;default:return e.isContentEditable}}function pn(){return y(window,"keydown").pipe(L(e=>!(e.metaKey||e.ctrlKey)),u(e=>({mode:ln("search")?"search":"global",type:e.key,claim(){e.preventDefault(),e.stopPropagation()}})),L(({mode:e})=>{if(e==="global"){let t=Ne();if(typeof t!="undefined")return!Pa(t)}return!0}),se())}function ve(){return new URL(location.href)}function Gt(e){location.href=e.href}function un(){return new O}function fn(){return location.hash.substring(1)}function mn(e){let t=We("a");t.href=e,t.addEventListener("click",r=>r.stopPropagation()),t.click()}function $a(){return y(window,"hashchange").pipe(u(fn),N(fn()),L(e=>e.length>0),se())}function dn(){return $a().pipe(S(e=>M(pe(`[id="${e}"]`))))}function gt(e){let t=matchMedia(e);return Qt(r=>t.addListener(()=>r(t.matches))).pipe(N(t.matches))}function hn(){return y(window,"beforeprint").pipe(B(void 0))}function Hr(e,t){return e.pipe(S(r=>r?t():J))}function Jt(e,t={credentials:"same-origin"}){return we(fetch(`${e}`,t)).pipe(L(r=>r.status===200))}function Te(e,t){return Jt(e,t).pipe(S(r=>r.json()),te(1))}function bn(e,t){let r=new DOMParser;return Jt(e,t).pipe(S(o=>o.text()),u(o=>r.parseFromString(o,"text/xml")),te(1))}function vn(e){let t=We("script");return t.src=e,de(()=>(document.head.appendChild(t),V(y(t,"load"),y(t,"error").pipe(S(()=>gr(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(B(void 0),j(()=>document.head.removeChild(t)),oe(1))))}function gn(){return{x:Math.max(0,pageXOffset),y:Math.max(0,pageYOffset)}}function jr({x:e,y:t}){window.scrollTo(e||0,t||0)}function xn(){return V(y(window,"scroll",{passive:!0}),y(window,"resize",{passive:!0})).pipe(u(gn),N(gn()))}function yn(){return{width:innerWidth,height:innerHeight}}function Sn(){return y(window,"resize",{passive:!0}).pipe(u(yn),N(yn()))}function wn(){return z([xn(),Sn()]).pipe(u(([e,t])=>({offset:e,size:t})),te(1))}function Xt(e,{viewport$:t,header$:r}){let o=t.pipe(D("size")),n=z([o,r]).pipe(u(()=>({x:e.offsetLeft,y:e.offsetTop})));return z([r,t,n]).pipe(u(([{height:i},{offset:a,size:s},{x:c,y:l}])=>({offset:{x:a.x-c,y:a.y-l+i},size:s})))}function En(e,{tx$:t}){let r=y(e,"message").pipe(u(({data:o})=>o));return t.pipe(kr(()=>r,{leading:!0,trailing:!0}),_(o=>e.postMessage(o)),Lr(r),se())}var Wa=ae("#__config"),ot=JSON.parse(Wa.textContent);ot.base=new URL(ot.base,ve()).toString().replace(/\/$/,"");function ue(){return ot}function ce(e){return ot.features.includes(e)}function X(e,t){return typeof t!="undefined"?ot.translations[e].replace("#",t.toString()):ot.translations[e]}function Oe(e,t=document){return ae(`[data-md-component=${e}]`,t)}function ne(e,t=document){return I(`[data-md-component=${e}]`,t)}var ai=ct(Fr());function Tn(e,t=0){e.setAttribute("tabindex",t.toString())}function On(e){e.removeAttribute("tabindex")}function _n(e,t){e.setAttribute("data-md-state","lock"),e.style.top=`-${t}px`}function Mn(e){let t=-1*parseInt(e.style.top,10);e.removeAttribute("data-md-state"),e.style.top="",t&&window.scrollTo(0,t)}function Ln(e,t){e.setAttribute("data-md-state",t)}function An(e){e.removeAttribute("data-md-state")}function kn(e,t){e.classList.toggle("md-nav__link--active",t)}function Cn(e){e.classList.remove("md-nav__link--active")}function Hn(e,t){e.firstElementChild.innerHTML=t}function jn(e,t){e.setAttribute("data-md-state",t)}function Rn(e){e.removeAttribute("data-md-state")}function Fn(e,t){e.setAttribute("data-md-state",t)}function In(e){e.removeAttribute("data-md-state")}function Pn(e,t){e.setAttribute("data-md-state",t)}function $n(e){e.removeAttribute("data-md-state")}function Wn(e,t){e.placeholder=t}function Vn(e){e.placeholder=X("search.placeholder")}function Un(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Un(e,r)}function $(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="boolean"?o.setAttribute(n,t[n]):t[n]&&o.setAttribute(n,"");for(let n of r)Un(o,n);return o}function Dn(e,t){let r=t;if(e.length>r){for(;e[r]!==" "&&--r>0;);return`${e.substring(0,r)}...`}return e}function Zt(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function Nn(e,t){switch(t){case 0:e.textContent=X("search.result.none");break;case 1:e.textContent=X("search.result.one");break;default:e.textContent=X("search.result.other",Zt(t))}}function Ir(e){e.textContent=X("search.result.placeholder")}function zn(e,t){e.appendChild(t)}function qn(e){e.innerHTML=""}function Qn(e,t){e.style.top=`${t}px`}function Kn(e){e.style.top=""}function Bn(e,t){let r=e.firstElementChild;r.style.height=`${t-2*r.offsetTop}px`}function Yn(e){let t=e.firstElementChild;t.style.height=""}function Gn(e,t){e.lastElementChild.appendChild(t)}function Jn(e,t){e.lastElementChild.setAttribute("data-md-state",t)}function Xn(e,t){e.setAttribute("data-md-state",t)}function Pr(e){e.removeAttribute("data-md-state")}function Zn(e,t){e.setAttribute("data-md-state",t)}function $r(e){e.removeAttribute("data-md-state")}function ei(e){return $("button",{class:"md-clipboard md-icon",title:X("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function ti(e,t){return $("aside",{class:"md-annotation",tabIndex:0},$("div",{class:"md-tooltip"},$("div",{class:"md-tooltip__inner md-typeset"},Array.from(t.childNodes))),$("span",{class:"md-annotation__index"},e))}var qe;(function(r){r[r.TEASER=1]="TEASER",r[r.PARENT=2]="PARENT"})(qe||(qe={}));function Wr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(a=>!e.terms[a]).map(a=>[$("del",null,a)," "]).flat().slice(0,-1),i=new URL(e.location);return ce("search.highlight")&&i.searchParams.set("h",Object.entries(e.terms).filter(([,a])=>a).reduce((a,[s])=>`${a} ${s}`.trim(),"")),$("a",{href:`${i}`,class:"md-search-result__link",tabIndex:-1},$("article",{class:["md-search-result__article",...r?["md-search-result__article--document"]:[]].join(" "),"data-md-score":e.score.toFixed(2)},r>0&&$("div",{class:"md-search-result__icon md-icon"}),$("h1",{class:"md-search-result__title"},e.title),o>0&&e.text.length>0&&$("p",{class:"md-search-result__teaser"},Dn(e.text,320)),e.tags&&e.tags.map(a=>$("span",{class:"md-tag"},a)),o>0&&n.length>0&&$("p",{class:"md-search-result__terms"},X("search.result.term.missing"),": ",n)))}function ri(e){let t=e[0].score,r=[...e],o=r.findIndex(l=>!l.location.includes("#")),[n]=r.splice(o,1),i=r.findIndex(l=>l.scoreWr(l,1)),...s.length?[$("details",{class:"md-search-result__more"},$("summary",{tabIndex:-1},s.length>0&&s.length===1?X("search.result.more.one"):X("search.result.more.other",s.length)),s.map(l=>Wr(l,1)))]:[]];return $("li",{class:"md-search-result__item"},c)}function oi(e){return $("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>$("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?Zt(r):r)))}function ni(e){return $("div",{class:"md-typeset__scrollwrap"},$("div",{class:"md-typeset__table"},e))}function Va(e){let t=ue(),r=new URL(`${e.version}/`,t.base);return $("li",{class:"md-version__item"},$("a",{href:`${r}`,class:"md-version__link"},e.title))}function ii(e,t){return $("div",{class:"md-version"},$("button",{class:"md-version__current","aria-label":X("select.version.title")},t.title),$("ul",{class:"md-version__list"},e.map(Va)))}var Ua=0;function Da(e,{viewport$:t}){let r=M(e).pipe(S(i=>{let a=i.closest("[data-tabs]");return a instanceof HTMLElement?V(...I(":scope > input",a).map(s=>y(s,"change"))):J})),o=[],n=e.closest(".annotate.highlighttable")||e.closest(".annotate.highlight");if(n){let i=n.nextElementSibling;if(i instanceof HTMLOListElement){let a=Array.from(i.children);i.remove();for(let s of I(".c, .c1, .cm",e)){let[,c=-1]=s.textContent.match(/\((\d+)\)/)||[],l=a[+c-1];if(typeof l!="undefined"){let p=ti(+c,l);s.replaceWith(p),o.push(p)}}}}return t.pipe(D("size"),Ce(r),u(()=>{let i=Se(e),a=vt(e);return R({scroll:a.width>i.width},o.length&&{annotations:o})}),D("scroll"))}function si(e,t){let r=new O;if(r.pipe(ye(gt("(hover)"))).subscribe(([{scroll:o},n])=>{o&&n?Tn(e):On(e)}),r.pipe(oe(1),bt(({annotations:o})=>!!(o==null?void 0:o.length)),u(({annotations:o})=>o.map(n=>ae(".md-tooltip",n))),$e(viewport$.pipe(D("size")))).subscribe(([o,{size:n}])=>{for(let i of o){let{x:a,width:s}=i.getBoundingClientRect();a+s>n.width?i.classList.add("md-tooltip--end"):i.classList.remove("md-tooltip--end")}}),ai.default.isSupported()){let o=e.closest("pre");o.id=`__code_${++Ua}`,o.insertBefore(ei(o.id),e)}return Da(e,t).pipe(_(r),j(()=>r.complete()),u(o=>R({ref:e},o)))}var Vr,Na=0;function ci(e){return Vr||(Vr=vn("https://unpkg.com/mermaid@8.8.4/dist/mermaid.min.js").pipe(_(()=>mermaid.initialize({startOnLoad:!1,themeCSS:za})),te(1))),Vr.subscribe(()=>{let t=e.innerText;mermaid.mermaidAPI.render(`__mermaid_${Na++}`,t,r=>{e.innerHTML=r})}),Vr.pipe(B({ref:e}))}var za=` + rect.actor { + fill: white; + } + .classLabel .box { + background-color: var(--md-mermaid-label-bg-color); + fill: var(--md-mermaid-label-bg-color); + opacity: 1; + } + .classLabel .label { + font-family: var(--md-mermaid-font-family); + fill: var(--md-mermaid-label-fg-color) + } + .statediagram-cluster.statediagram-cluster .inner { + fill: var(--md-default-bg-color); + } + .statediagram-state rect.divider { + stroke: var(--md-default-fg-color--lighter); + fill: var(--md-default-fg-color--lightest); + } + .cluster rect { + stroke: var(--md-default-fg-color--lighter); + fill: var(--md-default-fg-color--lightest); + } + .edgeLabel, + .edgeLabel rect { + background-color: var(--md-mermaid-label-bg-color); + fill: var(--md-mermaid-label-bg-color); + } + .cardinality text { + fill: inherit !important; + } + .cardinality, + g.classGroup text { + font-family: var(--md-mermaid-font-family); + fill: var(--md-mermaid-label-fg-color); + } + .edgeLabel .label rect { + fill: transparent; + } + .nodeLabel, + .label, + .label div .edgeLabel { + font-family: var(--md-mermaid-font-family); + color: var(--md-mermaid-label-fg-color); + } + .label foreignObject { + overflow: visible; + } + .arrowheadPath, + marker { + fill: var(--md-mermaid-edge-color) !important; + } + .edgePath .path, + .flowchart-link, + .relation, + .transition { + stroke: var(--md-mermaid-edge-color); + } + .statediagram-cluster rect, + g.classGroup line, + g.classGroup rect, + .node circle, + .node ellipse, + .node path, + .node polygon, + .node rect { + fill: var(--md-mermaid-node-bg-color); + stroke: var(--md-mermaid-node-fg-color); + } + .node circle.state-end { + fill: var(--md-mermaid-label-bg-color); + stroke: none; + } + .node circle.state-start { + fill: var(--md-mermaid-label-fg-color); + stroke: var(--md-mermaid-label-fg-color); + } +`;function qa(e,{target$:t,print$:r}){return t.pipe(u(o=>o.closest("details:not([open])")),L(o=>e===o),Ce(r),B(e))}function li(e,t){let r=new O;return r.subscribe(()=>{e.setAttribute("open",""),e.scrollIntoView()}),qa(e,t).pipe(_(r),j(()=>r.complete()),B({ref:e}))}var pi=We("table");function ui(e){return ze(e,pi),ze(pi,ni(e)),M({ref:e})}function Qa(e){return M(I(":scope > label",e)).pipe(S(t=>M(...t).pipe(ee(r=>{let o=r.previousElementSibling;return y(o,"change").pipe(B({active:r}))}))))}function fi(e){let t=new O;return t.subscribe(({active:r})=>{if(ce("content.tabs.link")){let o=r.innerText.trim();for(let i of I("[data-tabs]"))for(let a of I(":scope > label",i))if(a.innerText.trim()===o){let s=a.previousElementSibling;s.checked=!0;break}let n=__get("__tabs")||[];__set("__tabs",[...new Set([o,...n])])}}),Qa(e).pipe(_(t),j(()=>t.complete()),u(r=>R({ref:e},r)))}function mi(e,{target$:t,viewport$:r,print$:o}){return V(...I("pre:not([class^=mermaid]) > code",e).map(n=>si(n,{viewport$:r})),...I(".mermaid-experimental",e).map(n=>ci(n)),...I("table:not([class])",e).map(n=>ui(n)),...I("details",e).map(n=>li(n,{target$:t,print$:o})),...I("[data-tabs]",e).map(n=>fi(n)))}function Ka(e,{alert$:t}){return t.pipe(S(r=>V(M(!0),M(!1).pipe(ke(2e3))).pipe(u(o=>({message:r,open:o})))))}function di(e,t){let r=new O;return r.pipe(K(G)).subscribe(({message:o,open:n})=>{Hn(e,o),n?jn(e,"open"):Rn(e)}),Ka(e,t).pipe(_(r),j(()=>r.complete()),u(o=>R({ref:e},o)))}function Ba({viewport$:e}){if(!ce("header.autohide"))return M(!1);let t=e.pipe(u(({offset:{y:n}})=>n),xe(2,1),u(([n,i])=>[nMath.abs(i-n.y)>100),u(([,[n]])=>n),q()),o=Yt("search");return z([e,o]).pipe(u(([{offset:n},i])=>n.y>400&&!i),q(),S(n=>n?r:M(!1)),N(!1))}function hi(e,t){return de(()=>{let r=getComputedStyle(e);return M(r.position==="sticky"||r.position==="-webkit-sticky")}).pipe($e(Ve(e),Ba(t)),u(([r,{height:o},n])=>({height:r?o:0,sticky:r,hidden:n})),q((r,o)=>r.sticky===o.sticky&&r.height===o.height&&r.hidden===o.hidden),te(1))}function bi(e,{header$:t,main$:r}){let o=new O;return o.pipe(D("active"),$e(t),K(G)).subscribe(([{active:n},{hidden:i}])=>{n?Fn(e,i?"hidden":"shadow"):In(e)}),r.subscribe(n=>o.next(n)),t.pipe(u(n=>R({ref:e},n)))}function Ya(e,{viewport$:t,header$:r}){return Xt(e,{header$:r,viewport$:t}).pipe(u(({offset:{y:o}})=>{let{height:n}=Se(e);return{active:o>=n}}),D("active"))}function vi(e,t){let r=new O;r.pipe(K(G)).subscribe(({active:n})=>{n?Pn(e,"active"):$n(e)});let o=pe("article h1");return typeof o=="undefined"?J:Ya(o,t).pipe(_(r),j(()=>r.complete()),u(n=>R({ref:e},n)))}function gi(e,{viewport$:t,header$:r}){let o=r.pipe(u(({height:i})=>i),q()),n=o.pipe(S(()=>Ve(e).pipe(u(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),D("bottom"))));return z([o,n,t]).pipe(u(([i,{top:a,bottom:s},{offset:{y:c},size:{height:l}}])=>(l=Math.max(0,l-Math.max(0,a-c,i)-Math.max(0,l+c-s)),{offset:a-i,height:l,active:a-i<=c})),q((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function Ga(e){let t=__get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=M(...e).pipe(ee(o=>y(o,"change").pipe(B(o))),N(e[Math.max(0,t.index)]),u(o=>({index:e.indexOf(o),color:{scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),te(1));return r.subscribe(o=>{__set("__palette",o)}),r}function xi(e){let t=new O;t.subscribe(o=>{for(let[n,i]of Object.entries(o.color))typeof i=="string"&&document.body.setAttribute(`data-md-color-${n}`,i);for(let n=0;nt.complete()),u(o=>R({ref:e},o)))}var Ur=ct(Fr());function Ja(e){let t=I(".md-annotation",e);for(let o of t)o.hidden=!0;let r=e.innerText;for(let o of t)o.hidden=!1;return r}function yi({alert$:e}){Ur.default.isSupported()&&new k(t=>{new Ur.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Ja(ae(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).subscribe(()=>e.next(X("clipboard.copied")))}function Xa(e){if(e.length<2)return[""];let[t,r]=[...e].sort((n,i)=>n.length-i.length).map(n=>n.replace(/[^/]+$/,"")),o=0;if(t===r)o=t.length;else for(;t.charCodeAt(o)===r.charCodeAt(o);)o++;return e.map(n=>n.replace(t.slice(0,o),""))}function er(e){let t=__get("__sitemap",sessionStorage,e);if(t)return M(t);{let r=ue();return bn(new URL("sitemap.xml",e||r.base)).pipe(u(o=>Xa(I("loc",o).map(n=>n.textContent))),Ae([]),_(o=>__set("__sitemap",o,sessionStorage,e)))}}function Si({document$:e,location$:t,viewport$:r}){let o=ue();if(location.protocol==="file:")return;"scrollRestoration"in history&&(history.scrollRestoration="manual",y(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}));let n=pe("link[rel=icon]");typeof n!="undefined"&&(n.href=n.href);let i=er().pipe(u(l=>l.map(p=>`${o.base}/${p}`)),S(l=>y(document.body,"click").pipe(L(p=>!p.metaKey&&!p.ctrlKey),S(p=>{if(p.target instanceof Element){let m=p.target.closest("a");if(m&&!m.target&&l.includes(m.href))return p.preventDefault(),M({url:new URL(m.href)})}return J}))),se()),a=y(window,"popstate").pipe(L(l=>l.state!==null),u(l=>({url:new URL(location.href),offset:l.state})),se());V(i,a).pipe(q((l,p)=>l.url.href===p.url.href),u(({url:l})=>l)).subscribe(t);let s=t.pipe(D("pathname"),S(l=>Jt(l.href).pipe(tt(()=>(Gt(l),J)))),se());i.pipe(rt(s)).subscribe(({url:l})=>{history.pushState({},"",`${l}`)});let c=new DOMParser;s.pipe(S(l=>l.text()),u(l=>c.parseFromString(l,"text/html"))).subscribe(e),V(i,a).pipe(rt(e)).subscribe(({url:l,offset:p})=>{l.hash&&!p?mn(l.hash):jr(p||{y:0})}),e.pipe(Kt(1)).subscribe(l=>{for(let p of["title","link[rel=canonical]","meta[name=author]","meta[name=description]","[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=logo], .md-logo","[data-md-component=skip]"]){let m=pe(p),f=pe(p,l);typeof m!="undefined"&&typeof f!="undefined"&&ze(m,f)}}),e.pipe(Kt(1),u(()=>Oe("container")),S(l=>M(...I("script",l))),Sr(l=>{let p=We("script");if(l.src){for(let m of l.getAttributeNames())p.setAttribute(m,l.getAttribute(m));return ze(l,p),new k(m=>{p.onload=()=>m.complete()})}else return p.textContent=l.textContent,ze(l,p),ge})).subscribe(),r.pipe(Mr(i),wr(250),D("offset")).subscribe(({offset:l})=>{history.replaceState(l,"")}),V(i,a).pipe(xe(2,1),L(([l,p])=>l.url.pathname===p.url.pathname),u(([,l])=>l)).subscribe(({offset:l})=>{jr(l||{y:0})})}var ts=ct(Ei());function Dr(e){let t=new RegExp(e.separator,"img"),r=(o,n,i)=>`${n}${i}`;return o=>{o=o.replace(/[\s*+\-:~^]+/g," ").trim();let n=new RegExp(`(^|${e.separator})(${o.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(t,"|")})`,"img");return i=>i.replace(n,r).replace(/<\/mark>(\s+)]*>/img,"$1")}}function Ti(e){return e.split(/"([^"]+)"/g).map((t,r)=>r&1?t.replace(/^\b|^(?![^\x00-\x7F]|$)|\s+/g," +"):t).join("").replace(/"|(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g,"").trim()}var je;(function(n){n[n.SETUP=0]="SETUP",n[n.READY=1]="READY",n[n.QUERY=2]="QUERY",n[n.RESULT=3]="RESULT"})(je||(je={}));function nt(e){return e.type===1}function Oi(e){return e.type===2}function it(e){return e.type===3}function rs({config:e,docs:t,index:r}){e.lang.length===1&&e.lang[0]==="en"&&(e.lang=[X("search.config.lang")]),e.separator==="[\\s\\-]+"&&(e.separator=X("search.config.separator"));let n={pipeline:X("search.config.pipeline").split(/\s*,\s*/).filter(Boolean),suggestions:ce("search.suggest")};return{config:e,docs:t,index:r,options:n}}function _i(e,t){let r=ue(),o=new Worker(e),n=new O,i=En(o,{tx$:n}).pipe(u(a=>{if(it(a))for(let s of a.data.items)for(let c of s)c.location=`${r.base}/${c.location}`;return a}),se());return we(t).pipe(u(a=>({type:je.SETUP,data:rs(a)}))).subscribe(n.next.bind(n)),{tx$:n,rx$:i}}function Mi(){let e=ue(),t=Te(new URL("versions.json",e.base)),r=t.pipe(u(o=>{let[,n]=e.base.match(/([^/]+)\/?$/);return o.find(({version:i,aliases:a})=>i===n||a.includes(n))||o[0]}));z([t,r]).pipe(u(([o,n])=>new Map(o.filter(i=>i!==n).map(i=>[`${new URL(`${i.version}/`,e.base)}`,i]))),S(o=>y(document.body,"click").pipe(L(n=>!n.metaKey&&!n.ctrlKey),S(n=>{if(n.target instanceof Element){let i=n.target.closest("a");if(i&&!i.target&&o.has(i.href))return n.preventDefault(),M(i.href)}return J}),S(n=>{let{version:i}=o.get(n);return er(n).pipe(u(a=>{let c=ve().href.replace(`${e.base}/`,"");return a.includes(c)?new URL(`${i}/${c}`,e.base):new URL(n)}))})))).subscribe(o=>Gt(o)),z([t,r]).subscribe(([o,n])=>{var a;if(ae(".md-header__topic").appendChild(ii(o,n)),__get("__outdated",sessionStorage)===null){let s=((a=e.version)==null?void 0:a.default)||"latest",c=!n.aliases.includes(s);if(__set("__outdated",c,sessionStorage),c)for(let l of ne("outdated"))l.hidden=!1}})}function os(e,{rx$:t}){let r=(__search==null?void 0:__search.transform)||Ti,o=rn(e),n=V(y(e,"keyup"),y(e,"focus").pipe(ke(1))).pipe(u(()=>r(e.value)),q()),i=ve();return i.searchParams.has("q")&&(Ue("search",!0),t.pipe(L(nt),oe(1)).subscribe(()=>{e.value=i.searchParams.get("q"),He(e)})),z([n,o]).pipe(u(([a,s])=>({value:a,focus:s})))}function Li(e,{tx$:t,rx$:r}){let o=new O;return o.pipe(D("value"),u(({value:n})=>({type:je.QUERY,data:n}))).subscribe(t.next.bind(t)),o.pipe(D("focus")).subscribe(({focus:n})=>{n?(Ue("search",n),Wn(e,"")):Vn(e)}),y(e.form,"reset").pipe(Ar(o.pipe(Tr(1)))).subscribe(()=>He(e)),os(e,{tx$:t,rx$:r}).pipe(_(o),j(()=>o.complete()),u(n=>R({ref:e},n)))}function Ai(e,{rx$:t},{query$:r}){let o=new O,n=sn(e.parentElement).pipe(L(Boolean)),i=ae(":scope > :first-child",e),a=ae(":scope > :last-child",e);return t.pipe(L(nt),oe(1)).subscribe(()=>{Ir(i)}),o.pipe(K(G),ye(r)).subscribe(([{items:c},{value:l}])=>{l?Nn(i,c.length):Ir(i)}),o.pipe(K(G),_(()=>qn(a)),S(({items:c})=>V(M(...c.slice(0,10)),M(...c.slice(10)).pipe(xe(4),Cr(n),S(([l])=>M(...l)))))).subscribe(c=>{zn(a,ri(c))}),t.pipe(L(it),u(({data:c})=>c)).pipe(_(o),j(()=>o.complete()),u(c=>R({ref:e},c)))}function ns(e,{query$:t}){return t.pipe(u(({value:r})=>{let o=ve();return o.hash="",o.searchParams.delete("h"),o.searchParams.set("q",r),{url:o}}))}function ki(e,t){let r=new O;return r.subscribe(({url:o})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${o}`}),y(e,"click").subscribe(o=>o.preventDefault()),ns(e,t).pipe(_(r),j(()=>r.complete()),u(o=>R({ref:e},o)))}function Ci(e,{rx$:t},{keyboard$:r}){let o=new O,n=Oe("search-query"),i=y(n,"keydown").pipe(K(Fe),u(()=>n.value),q());return o.pipe($e(i),u(([{suggestions:s},c])=>{let l=c.split(/([\s-]+)/);if((s==null?void 0:s.length)&&l[l.length-1]){let p=s[s.length-1];p.startsWith(l[l.length-1])&&(l[l.length-1]=p)}else l.length=0;return l})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(L(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(L(it),u(({data:s})=>s)).pipe(_(o),j(()=>o.complete()),u(()=>({ref:e})))}function Hi(e,{index$:t,keyboard$:r}){let o=ue(),n=_i(o.search,t),i=Oe("search-query",e),a=Oe("search-result",e),{tx$:s,rx$:c}=n;s.pipe(L(Oi),rt(c.pipe(L(nt),oe(1)))).subscribe(s.next.bind(s)),r.pipe(L(({mode:m})=>m==="search")).subscribe(m=>{let f=Ne();switch(m.type){case"Enter":if(f===i){let d=new Map;for(let v of I(":first-child [href]",a)){let h=v.firstElementChild;d.set(v,parseFloat(h.getAttribute("data-md-score")))}if(d.size){let[[v]]=[...d].sort(([,h],[,U])=>U-h);v.click()}m.claim()}break;case"Escape":case"Tab":Ue("search",!1),He(i,!1);break;case"ArrowUp":case"ArrowDown":if(typeof f=="undefined")He(i);else{let d=[i,...I(":not(details) > [href], summary, details[open] [href]",a)],v=Math.max(0,(Math.max(0,d.indexOf(f))+d.length+(m.type==="ArrowUp"?-1:1))%d.length);He(d[v])}m.claim();break;default:i!==Ne()&&He(i)}}),r.pipe(L(({mode:m})=>m==="global")).subscribe(m=>{switch(m.type){case"f":case"s":case"/":He(i),cn(i),m.claim();break}});let l=Li(i,n),p=Ai(a,n,{query$:l});return V(l,p).pipe(Ce(...ne("search-share",e).map(m=>ki(m,{query$:l})),...ne("search-suggest",e).map(m=>Ci(m,n,{keyboard$:r}))))}function ji(e,{index$:t,location$:r}){return z([t,r.pipe(N(ve()),L(o=>o.searchParams.has("h")))]).pipe(u(([o,n])=>Dr(o.config)(n.searchParams.get("h"))),u(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)==null?void 0:a.offsetHeight){let c=s.textContent,l=o(c);l.length>c.length&&n.set(s,l)}for(let[s,c]of n){let{childNodes:l}=$("span",null,c);s.replaceWith(...Array.from(l))}return{ref:e,nodes:n}}))}function is(e,{viewport$:t,main$:r}){let o=e.parentElement.offsetTop-e.parentElement.parentElement.offsetTop;return z([r,t]).pipe(u(([{offset:n,height:i},{offset:{y:a}}])=>(i=i+Math.min(o,Math.max(0,a-n))-o,{height:i,locked:a>=n+o})),q((n,i)=>n.height===i.height&&n.locked===i.locked))}function Nr(e,o){var n=o,{header$:t}=n,r=Yr(n,["header$"]);let i=new O;return i.pipe(K(G),ye(t)).subscribe({next([{height:a},{height:s}]){Bn(e,a),Qn(e,s)},complete(){Kn(e),Yn(e)}}),i.pipe(K(G),oe(1)).subscribe(()=>{for(let a of I(".md-nav__link--active[href]",e)){let s=nn(a);if(typeof s!="undefined"){let c=a.offsetTop-s.offsetTop,{height:l}=Se(s);c-l+a.offsetHeight>0&&s.scrollTo(0,c-l/2)}}}),is(e,r).pipe(_(i),j(()=>i.complete()),u(a=>R({ref:e},a)))}function Ri(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return ht(Te(`${r}/releases/latest`).pipe(u(o=>({version:o.tag_name})),Ae({})),Te(r).pipe(u(o=>({stars:o.stargazers_count,forks:o.forks_count})),Ae({}))).pipe(u(([o,n])=>R(R({},o),n)))}else{let r=`https://api.github.com/repos/${e}`;return Te(r).pipe(u(o=>({repositories:o.public_repos})),Ae({}))}}function Fi(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Te(r).pipe(u(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Ae({}))}function Ii(e){let[t]=e.match(/(git(?:hub|lab))/i)||[];switch(t.toLowerCase()){case"github":let[,r,o]=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);return Ri(r,o);case"gitlab":let[,n,i]=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i);return Fi(n,i);default:return J}}var as;function ss(e){return as||(as=de(()=>{let t=__get("__source",sessionStorage);return t?M(t):Ii(e.href).pipe(_(r=>__set("__source",r,sessionStorage)))}).pipe(tt(()=>J),L(t=>Object.keys(t).length>0),u(t=>({facts:t})),te(1)))}function Pi(e){let t=new O;return t.subscribe(({facts:r})=>{Gn(e,oi(r)),Jn(e,"done")}),ss(e).pipe(_(t),j(()=>t.complete()),u(r=>R({ref:e},r)))}function cs(e,{viewport$:t,header$:r}){return Ve(document.body).pipe(S(()=>Xt(e,{header$:r,viewport$:t})),u(({offset:{y:o}})=>({hidden:o>=10})),D("hidden"))}function $i(e,t){let r=new O;return r.pipe(K(G)).subscribe({next({hidden:o}){o?Xn(e,"hidden"):Pr(e)},complete(){Pr(e)}}),(ce("navigation.tabs.sticky")?M({hidden:!1}):cs(e,t)).pipe(_(r),j(()=>r.complete()),u(o=>R({ref:e},o)))}function ls(e,{viewport$:t,header$:r}){let o=new Map,n=I("[href^=\\#]",e);for(let s of n){let c=decodeURIComponent(s.hash.substring(1)),l=pe(`[id="${c}"]`);typeof l!="undefined"&&o.set(s,l)}let i=r.pipe(u(s=>24+s.height));return Ve(document.body).pipe(D("height"),S(s=>de(()=>{let c=[];return M([...o].reduce((l,[p,m])=>{for(;c.length&&o.get(c[c.length-1]).tagName>=m.tagName;)c.pop();let f=m.offsetTop;for(;!f&&m.parentElement;)m=m.parentElement,f=m.offsetTop;return l.set([...c=[...c,p]].reverse(),f)},new Map))}).pipe(u(c=>new Map([...c].sort(([,l],[,p])=>l-p))),S(c=>z([t,i]).pipe(Or(([l,p],[{offset:{y:m},size:f},d])=>{let v=m+f.height>=Math.floor(s.height);for(;p.length;){let[,h]=p[0];if(h-d=m&&!v)p=[l.pop(),...p];else break}return[l,p]},[[],[...c]]),q((l,p)=>l[0]===p[0]&&l[1]===p[1])))))).pipe(u(([s,c])=>({prev:s.map(([l])=>l),next:c.map(([l])=>l)})),N({prev:[],next:[]}),xe(2,1),u(([s,c])=>s.prev.length{for(let[i]of n)Cn(i),An(i);for(let[i,[a]]of o.entries())kn(a,i===o.length-1),Ln(a,"blur");if(ce("navigation.tracking")){let i=ve(),a=o[o.length-1];if(a&&a.length){let[s]=a,{hash:c}=new URL(s.href);i.hash!==c&&(i.hash=c,history.replaceState({},"",`${i}`))}else i.hash="",history.replaceState({},"",`${i}`)}}),ls(e,t).pipe(_(r),j(()=>r.complete()),u(o=>R({ref:e},o)))}function ps(e,{viewport$:t,main$:r}){let o=t.pipe(u(({offset:{y:i}})=>i),xe(2,1),u(([i,a])=>i>a),q()),n=r.pipe(D("active"));return z([n,o]).pipe(u(([{active:i},a])=>({hidden:!(i&&a)})),q((i,a)=>i.hidden===a.hidden))}function Vi(e,t){let r=new O;return r.pipe(K(G)).subscribe({next({hidden:o}){o?Zn(e,"hidden"):$r(e)},complete(){$r(e)}}),ps(e,t).pipe(_(r),j(()=>r.complete()),u(o=>R({ref:e},o)))}function Ui({document$:e,tablet$:t}){e.pipe(S(()=>M(...I("[data-md-state=indeterminate]"))),_(r=>{r.indeterminate=!0,r.checked=!1}),ee(r=>y(r,"change").pipe(bt(()=>r.hasAttribute("data-md-state")),B(r))),ye(t)).subscribe(([r,o])=>{r.removeAttribute("data-md-state"),o&&(r.checked=!1)})}function us(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Di({document$:e}){e.pipe(S(()=>M(...I("[data-md-scrollfix]"))),_(t=>t.removeAttribute("data-md-scrollfix")),L(us),ee(t=>y(t,"touchstart").pipe(B(t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function Ni({viewport$:e,tablet$:t}){z([Yt("search"),t]).pipe(u(([r,o])=>r&&!o),S(r=>M(r).pipe(ke(r?400:100),K(G))),ye(e)).subscribe(([r,{offset:{y:o}}])=>{r?_n(document.body,o):Mn(document.body)})}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var at=tn(),tr=un(),zr=dn(),qr=pn(),he=wn(),rr=gt("(min-width: 960px)"),zi=gt("(min-width: 1220px)"),qi=hn(),Qi=ue(),Ki=document.forms.namedItem("search")?(__search==null?void 0:__search.index)||Te(`${Qi.base}/search/search_index.json`):J,Qr=new O;yi({alert$:Qr});ce("navigation.instant")&&Si({document$:at,location$:tr,viewport$:he});var Yi;((Yi=Qi.version)==null?void 0:Yi.provider)==="mike"&&Mi();V(tr,zr).pipe(ke(125)).subscribe(()=>{Ue("drawer",!1),Ue("search",!1)});qr.pipe(L(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=pe("[href][rel=prev]");typeof t!="undefined"&&t.click();break;case"n":case".":let r=pe("[href][rel=next]");typeof r!="undefined"&&r.click();break}});Ui({document$:at,tablet$:rr});Di({document$:at});Ni({viewport$:he,tablet$:rr});var Qe=hi(Oe("header"),{viewport$:he}),or=at.pipe(u(()=>Oe("main")),S(e=>gi(e,{viewport$:he,header$:Qe})),te(1)),fs=V(...ne("dialog").map(e=>di(e,{alert$:Qr})),...ne("header").map(e=>bi(e,{viewport$:he,header$:Qe,main$:or})),...ne("palette").map(e=>xi(e)),...ne("search").map(e=>Hi(e,{index$:Ki,keyboard$:qr})),...ne("source").map(e=>Pi(e))),ms=de(()=>V(...ne("content").map(e=>mi(e,{target$:zr,viewport$:he,print$:qi})),...ne("content").map(e=>ce("search.highlight")?ji(e,{index$:Ki,location$:tr}):J),...ne("header-title").map(e=>vi(e,{viewport$:he,header$:Qe})),...ne("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Hr(zi,()=>Nr(e,{viewport$:he,header$:Qe,main$:or})):Hr(rr,()=>Nr(e,{viewport$:he,header$:Qe,main$:or}))),...ne("tabs").map(e=>$i(e,{viewport$:he,header$:Qe})),...ne("toc").map(e=>Wi(e,{viewport$:he,header$:Qe})),...ne("top").map(e=>Vi(e,{viewport$:he,main$:or})))),Bi=at.pipe(S(()=>ms),Ce(fs),te(1));Bi.subscribe();window.document$=at;window.location$=tr;window.target$=zr;window.keyboard$=qr;window.viewport$=he;window.tablet$=rr;window.screen$=zi;window.print$=qi;window.alert$=Qr;window.component$=Bi;})(); +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */ +/*! ***************************************************************************** +Copyright (c) Microsoft Corporation. + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. +***************************************************************************** */ diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.ar.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.ar.min.js new file mode 100644 index 0000000000..248ddc5d14 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.ar.min.js @@ -0,0 +1 @@ +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.ar=function(){this.pipeline.reset(),this.pipeline.add(e.ar.trimmer,e.ar.stopWordFilter,e.ar.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.ar.stemmer))},e.ar.wordCharacters="ء-ٛٱـ",e.ar.trimmer=e.trimmerSupport.generateTrimmer(e.ar.wordCharacters),e.Pipeline.registerFunction(e.ar.trimmer,"trimmer-ar"),e.ar.stemmer=function(){var e=this;return e.result=!1,e.preRemoved=!1,e.sufRemoved=!1,e.pre={pre1:"ف ك ب و س ل ن ا ي ت",pre2:"ال لل",pre3:"بال وال فال تال كال ولل",pre4:"فبال كبال وبال وكال"},e.suf={suf1:"ه ك ت ن ا ي",suf2:"نك نه ها وك يا اه ون ين تن تم نا وا ان كم كن ني نن ما هم هن تك ته ات يه",suf3:"تين كهم نيه نهم ونه وها يهم ونا ونك وني وهم تكم تنا تها تني تهم كما كها ناه نكم هنا تان يها",suf4:"كموه ناها ونني ونهم تكما تموه تكاه كماه ناكم ناهم نيها وننا"},e.patterns=JSON.parse('{"pt43":[{"pt":[{"c":"ا","l":1}]},{"pt":[{"c":"ا,ت,ن,ي","l":0}],"mPt":[{"c":"ف","l":0,"m":1},{"c":"ع","l":1,"m":2},{"c":"ل","l":2,"m":3}]},{"pt":[{"c":"و","l":2}],"mPt":[{"c":"ف","l":0,"m":0},{"c":"ع","l":1,"m":1},{"c":"ل","l":2,"m":3}]},{"pt":[{"c":"ا","l":2}]},{"pt":[{"c":"ي","l":2}],"mPt":[{"c":"ف","l":0,"m":0},{"c":"ع","l":1,"m":1},{"c":"ا","l":2},{"c":"ل","l":3,"m":3}]},{"pt":[{"c":"م","l":0}]}],"pt53":[{"pt":[{"c":"ت","l":0},{"c":"ا","l":2}]},{"pt":[{"c":"ا,ن,ت,ي","l":0},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ت","l":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"ا","l":0},{"c":"ا","l":2}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ع","l":2,"m":3},{"c":"ل","l":3,"m":4},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"ا","l":0},{"c":"ا","l":3}],"mPt":[{"c":"ف","l":0,"m":1},{"c":"ع","l":1,"m":2},{"c":"ل","l":2,"m":4}]},{"pt":[{"c":"ا","l":3},{"c":"ن","l":4}]},{"pt":[{"c":"ت","l":0},{"c":"ي","l":3}]},{"pt":[{"c":"م","l":0},{"c":"و","l":3}]},{"pt":[{"c":"ا","l":1},{"c":"و","l":3}]},{"pt":[{"c":"و","l":1},{"c":"ا","l":2}]},{"pt":[{"c":"م","l":0},{"c":"ا","l":3}]},{"pt":[{"c":"م","l":0},{"c":"ي","l":3}]},{"pt":[{"c":"ا","l":2},{"c":"ن","l":3}]},{"pt":[{"c":"م","l":0},{"c":"ن","l":1}],"mPt":[{"c":"ا","l":0},{"c":"ن","l":1},{"c":"ف","l":2,"m":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"م","l":0},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ت","l":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"م","l":0},{"c":"ا","l":2}]},{"pt":[{"c":"م","l":1},{"c":"ا","l":3}]},{"pt":[{"c":"ي,ت,ا,ن","l":0},{"c":"ت","l":1}],"mPt":[{"c":"ف","l":0,"m":2},{"c":"ع","l":1,"m":3},{"c":"ا","l":2},{"c":"ل","l":3,"m":4}]},{"pt":[{"c":"ت,ي,ا,ن","l":0},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ت","l":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"ا","l":2},{"c":"ي","l":3}]},{"pt":[{"c":"ا,ي,ت,ن","l":0},{"c":"ن","l":1}],"mPt":[{"c":"ا","l":0},{"c":"ن","l":1},{"c":"ف","l":2,"m":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"ا","l":3},{"c":"ء","l":4}]}],"pt63":[{"pt":[{"c":"ا","l":0},{"c":"ت","l":2},{"c":"ا","l":4}]},{"pt":[{"c":"ا,ت,ن,ي","l":0},{"c":"س","l":1},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"س","l":1},{"c":"ت","l":2},{"c":"ف","l":3,"m":3},{"c":"ع","l":4,"m":4},{"c":"ا","l":5},{"c":"ل","l":6,"m":5}]},{"pt":[{"c":"ا,ن,ت,ي","l":0},{"c":"و","l":3}]},{"pt":[{"c":"م","l":0},{"c":"س","l":1},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"س","l":1},{"c":"ت","l":2},{"c":"ف","l":3,"m":3},{"c":"ع","l":4,"m":4},{"c":"ا","l":5},{"c":"ل","l":6,"m":5}]},{"pt":[{"c":"ي","l":1},{"c":"ي","l":3},{"c":"ا","l":4},{"c":"ء","l":5}]},{"pt":[{"c":"ا","l":0},{"c":"ن","l":1},{"c":"ا","l":4}]}],"pt54":[{"pt":[{"c":"ت","l":0}]},{"pt":[{"c":"ا,ي,ت,ن","l":0}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ع","l":2,"m":2},{"c":"ل","l":3,"m":3},{"c":"ر","l":4,"m":4},{"c":"ا","l":5},{"c":"ر","l":6,"m":4}]},{"pt":[{"c":"م","l":0}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ع","l":2,"m":2},{"c":"ل","l":3,"m":3},{"c":"ر","l":4,"m":4},{"c":"ا","l":5},{"c":"ر","l":6,"m":4}]},{"pt":[{"c":"ا","l":2}]},{"pt":[{"c":"ا","l":0},{"c":"ن","l":2}]}],"pt64":[{"pt":[{"c":"ا","l":0},{"c":"ا","l":4}]},{"pt":[{"c":"م","l":0},{"c":"ت","l":1}]}],"pt73":[{"pt":[{"c":"ا","l":0},{"c":"س","l":1},{"c":"ت","l":2},{"c":"ا","l":5}]}],"pt75":[{"pt":[{"c":"ا","l":0},{"c":"ا","l":5}]}]}'),e.execArray=["cleanWord","removeDiacritics","cleanAlef","removeStopWords","normalizeHamzaAndAlef","removeStartWaw","removePre432","removeEndTaa","wordCheck"],e.stem=function(){var r=0;for(e.result=!1,e.preRemoved=!1,e.sufRemoved=!1;r=0)return!0},e.normalizeHamzaAndAlef=function(){return e.word=e.word.replace("ؤ","ء"),e.word=e.word.replace("ئ","ء"),e.word=e.word.replace(/([\u0627])\1+/gi,"ا"),!1},e.removeEndTaa=function(){return!(e.word.length>2)||(e.word=e.word.replace(/[\u0627]$/,""),e.word=e.word.replace("ة",""),!1)},e.removeStartWaw=function(){return e.word.length>3&&"و"==e.word[0]&&"و"==e.word[1]&&(e.word=e.word.slice(1)),!1},e.removePre432=function(){var r=e.word;if(e.word.length>=7){var t=new RegExp("^("+e.pre.pre4.split(" ").join("|")+")");e.word=e.word.replace(t,"")}if(e.word==r&&e.word.length>=6){var c=new RegExp("^("+e.pre.pre3.split(" ").join("|")+")");e.word=e.word.replace(c,"")}if(e.word==r&&e.word.length>=5){var l=new RegExp("^("+e.pre.pre2.split(" ").join("|")+")");e.word=e.word.replace(l,"")}return r!=e.word&&(e.preRemoved=!0),!1},e.patternCheck=function(r){for(var t=0;t3){var t=new RegExp("^("+e.pre.pre1.split(" ").join("|")+")");e.word=e.word.replace(t,"")}return r!=e.word&&(e.preRemoved=!0),!1},e.removeSuf1=function(){var r=e.word;if(0==e.sufRemoved&&e.word.length>3){var t=new RegExp("("+e.suf.suf1.split(" ").join("|")+")$");e.word=e.word.replace(t,"")}return r!=e.word&&(e.sufRemoved=!0),!1},e.removeSuf432=function(){var r=e.word;if(e.word.length>=6){var t=new RegExp("("+e.suf.suf4.split(" ").join("|")+")$");e.word=e.word.replace(t,"")}if(e.word==r&&e.word.length>=5){var c=new RegExp("("+e.suf.suf3.split(" ").join("|")+")$");e.word=e.word.replace(c,"")}if(e.word==r&&e.word.length>=4){var l=new RegExp("("+e.suf.suf2.split(" ").join("|")+")$");e.word=e.word.replace(l,"")}return r!=e.word&&(e.sufRemoved=!0),!1},e.wordCheck=function(){for(var r=(e.word,[e.removeSuf432,e.removeSuf1,e.removePre1]),t=0,c=!1;e.word.length>=7&&!e.result&&t=f.limit)return;f.cursor++}for(;!f.out_grouping(w,97,248);){if(f.cursor>=f.limit)return;f.cursor++}d=f.cursor,d=d&&(r=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,e=f.find_among_b(c,32),f.limit_backward=r,e))switch(f.bra=f.cursor,e){case 1:f.slice_del();break;case 2:f.in_grouping_b(p,97,229)&&f.slice_del()}}function t(){var e,r=f.limit-f.cursor;f.cursor>=d&&(e=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,f.find_among_b(l,4)?(f.bra=f.cursor,f.limit_backward=e,f.cursor=f.limit-r,f.cursor>f.limit_backward&&(f.cursor--,f.bra=f.cursor,f.slice_del())):f.limit_backward=e)}function s(){var e,r,i,n=f.limit-f.cursor;if(f.ket=f.cursor,f.eq_s_b(2,"st")&&(f.bra=f.cursor,f.eq_s_b(2,"ig")&&f.slice_del()),f.cursor=f.limit-n,f.cursor>=d&&(r=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,e=f.find_among_b(m,5),f.limit_backward=r,e))switch(f.bra=f.cursor,e){case 1:f.slice_del(),i=f.limit-f.cursor,t(),f.cursor=f.limit-i;break;case 2:f.slice_from("løs")}}function o(){var e;f.cursor>=d&&(e=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,f.out_grouping_b(w,97,248)?(f.bra=f.cursor,u=f.slice_to(u),f.limit_backward=e,f.eq_v_b(u)&&f.slice_del()):f.limit_backward=e)}var a,d,u,c=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],l=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],m=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("løst",-1,2)],w=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],p=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],f=new i;this.setCurrent=function(e){f.setCurrent(e)},this.getCurrent=function(){return f.getCurrent()},this.stem=function(){var r=f.cursor;return e(),f.limit_backward=r,f.cursor=f.limit,n(),f.cursor=f.limit,t(),f.cursor=f.limit,s(),f.cursor=f.limit,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.da.stemmer,"stemmer-da"),e.da.stopWordFilter=e.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu når og også om op os over på selv sig sin sine sit skal skulle som sådan thi til ud under var vi vil ville vor være været".split(" ")),e.Pipeline.registerFunction(e.da.stopWordFilter,"stopWordFilter-da")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.de.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.de.min.js new file mode 100644 index 0000000000..f3b5c108c9 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.de.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `German` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.de=function(){this.pipeline.reset(),this.pipeline.add(e.de.trimmer,e.de.stopWordFilter,e.de.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.de.stemmer))},e.de.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.de.trimmer=e.trimmerSupport.generateTrimmer(e.de.wordCharacters),e.Pipeline.registerFunction(e.de.trimmer,"trimmer-de"),e.de.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){function e(e,r,n){return!(!v.eq_s(1,e)||(v.ket=v.cursor,!v.in_grouping(p,97,252)))&&(v.slice_from(r),v.cursor=n,!0)}function i(){for(var r,n,i,s,t=v.cursor;;)if(r=v.cursor,v.bra=r,v.eq_s(1,"ß"))v.ket=v.cursor,v.slice_from("ss");else{if(r>=v.limit)break;v.cursor=r+1}for(v.cursor=t;;)for(n=v.cursor;;){if(i=v.cursor,v.in_grouping(p,97,252)){if(s=v.cursor,v.bra=s,e("u","U",i))break;if(v.cursor=s,e("y","Y",i))break}if(i>=v.limit)return void(v.cursor=n);v.cursor=i+1}}function s(){for(;!v.in_grouping(p,97,252);){if(v.cursor>=v.limit)return!0;v.cursor++}for(;!v.out_grouping(p,97,252);){if(v.cursor>=v.limit)return!0;v.cursor++}return!1}function t(){m=v.limit,l=m;var e=v.cursor+3;0<=e&&e<=v.limit&&(d=e,s()||(m=v.cursor,m=v.limit)return;v.cursor++}}}function c(){return m<=v.cursor}function u(){return l<=v.cursor}function a(){var e,r,n,i,s=v.limit-v.cursor;if(v.ket=v.cursor,(e=v.find_among_b(w,7))&&(v.bra=v.cursor,c()))switch(e){case 1:v.slice_del();break;case 2:v.slice_del(),v.ket=v.cursor,v.eq_s_b(1,"s")&&(v.bra=v.cursor,v.eq_s_b(3,"nis")&&v.slice_del());break;case 3:v.in_grouping_b(g,98,116)&&v.slice_del()}if(v.cursor=v.limit-s,v.ket=v.cursor,(e=v.find_among_b(f,4))&&(v.bra=v.cursor,c()))switch(e){case 1:v.slice_del();break;case 2:if(v.in_grouping_b(k,98,116)){var t=v.cursor-3;v.limit_backward<=t&&t<=v.limit&&(v.cursor=t,v.slice_del())}}if(v.cursor=v.limit-s,v.ket=v.cursor,(e=v.find_among_b(_,8))&&(v.bra=v.cursor,u()))switch(e){case 1:v.slice_del(),v.ket=v.cursor,v.eq_s_b(2,"ig")&&(v.bra=v.cursor,r=v.limit-v.cursor,v.eq_s_b(1,"e")||(v.cursor=v.limit-r,u()&&v.slice_del()));break;case 2:n=v.limit-v.cursor,v.eq_s_b(1,"e")||(v.cursor=v.limit-n,v.slice_del());break;case 3:if(v.slice_del(),v.ket=v.cursor,i=v.limit-v.cursor,!v.eq_s_b(2,"er")&&(v.cursor=v.limit-i,!v.eq_s_b(2,"en")))break;v.bra=v.cursor,c()&&v.slice_del();break;case 4:v.slice_del(),v.ket=v.cursor,e=v.find_among_b(b,2),e&&(v.bra=v.cursor,u()&&1==e&&v.slice_del())}}var d,l,m,h=[new r("",-1,6),new r("U",0,2),new r("Y",0,1),new r("ä",0,3),new r("ö",0,4),new r("ü",0,5)],w=[new r("e",-1,2),new r("em",-1,1),new r("en",-1,2),new r("ern",-1,1),new r("er",-1,1),new r("s",-1,3),new r("es",5,2)],f=[new r("en",-1,1),new r("er",-1,1),new r("st",-1,2),new r("est",2,1)],b=[new r("ig",-1,1),new r("lich",-1,1)],_=[new r("end",-1,1),new r("ig",-1,2),new r("ung",-1,1),new r("lich",-1,3),new r("isch",-1,2),new r("ik",-1,2),new r("heit",-1,3),new r("keit",-1,4)],p=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,8,0,32,8],g=[117,30,5],k=[117,30,4],v=new n;this.setCurrent=function(e){v.setCurrent(e)},this.getCurrent=function(){return v.getCurrent()},this.stem=function(){var e=v.cursor;return i(),v.cursor=e,t(),v.limit_backward=e,v.cursor=v.limit,a(),v.cursor=v.limit_backward,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.de.stemmer,"stemmer-de"),e.de.stopWordFilter=e.generateStopWordFilter("aber alle allem allen aller alles als also am an ander andere anderem anderen anderer anderes anderm andern anderr anders auch auf aus bei bin bis bist da damit dann das dasselbe dazu daß dein deine deinem deinen deiner deines dem demselben den denn denselben der derer derselbe derselben des desselben dessen dich die dies diese dieselbe dieselben diesem diesen dieser dieses dir doch dort du durch ein eine einem einen einer eines einig einige einigem einigen einiger einiges einmal er es etwas euch euer eure eurem euren eurer eures für gegen gewesen hab habe haben hat hatte hatten hier hin hinter ich ihm ihn ihnen ihr ihre ihrem ihren ihrer ihres im in indem ins ist jede jedem jeden jeder jedes jene jenem jenen jener jenes jetzt kann kein keine keinem keinen keiner keines können könnte machen man manche manchem manchen mancher manches mein meine meinem meinen meiner meines mich mir mit muss musste nach nicht nichts noch nun nur ob oder ohne sehr sein seine seinem seinen seiner seines selbst sich sie sind so solche solchem solchen solcher solches soll sollte sondern sonst um und uns unse unsem unsen unser unses unter viel vom von vor war waren warst was weg weil weiter welche welchem welchen welcher welches wenn werde werden wie wieder will wir wird wirst wo wollen wollte während würde würden zu zum zur zwar zwischen über".split(" ")),e.Pipeline.registerFunction(e.de.stopWordFilter,"stopWordFilter-de")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.du.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.du.min.js new file mode 100644 index 0000000000..49a0f3f0ac --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.du.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Dutch` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");console.warn('[Lunr Languages] Please use the "nl" instead of the "du". The "nl" code is the standard code for Dutch language, and "du" will be removed in the next major versions.'),e.du=function(){this.pipeline.reset(),this.pipeline.add(e.du.trimmer,e.du.stopWordFilter,e.du.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.du.stemmer))},e.du.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.du.trimmer=e.trimmerSupport.generateTrimmer(e.du.wordCharacters),e.Pipeline.registerFunction(e.du.trimmer,"trimmer-du"),e.du.stemmer=function(){var r=e.stemmerSupport.Among,i=e.stemmerSupport.SnowballProgram,n=new function(){function e(){for(var e,r,i,o=C.cursor;;){if(C.bra=C.cursor,e=C.find_among(b,11))switch(C.ket=C.cursor,e){case 1:C.slice_from("a");continue;case 2:C.slice_from("e");continue;case 3:C.slice_from("i");continue;case 4:C.slice_from("o");continue;case 5:C.slice_from("u");continue;case 6:if(C.cursor>=C.limit)break;C.cursor++;continue}break}for(C.cursor=o,C.bra=o,C.eq_s(1,"y")?(C.ket=C.cursor,C.slice_from("Y")):C.cursor=o;;)if(r=C.cursor,C.in_grouping(q,97,232)){if(i=C.cursor,C.bra=i,C.eq_s(1,"i"))C.ket=C.cursor,C.in_grouping(q,97,232)&&(C.slice_from("I"),C.cursor=r);else if(C.cursor=i,C.eq_s(1,"y"))C.ket=C.cursor,C.slice_from("Y"),C.cursor=r;else if(n(r))break}else if(n(r))break}function n(e){return C.cursor=e,e>=C.limit||(C.cursor++,!1)}function o(){_=C.limit,f=_,t()||(_=C.cursor,_<3&&(_=3),t()||(f=C.cursor))}function t(){for(;!C.in_grouping(q,97,232);){if(C.cursor>=C.limit)return!0;C.cursor++}for(;!C.out_grouping(q,97,232);){if(C.cursor>=C.limit)return!0;C.cursor++}return!1}function s(){for(var e;;)if(C.bra=C.cursor,e=C.find_among(p,3))switch(C.ket=C.cursor,e){case 1:C.slice_from("y");break;case 2:C.slice_from("i");break;case 3:if(C.cursor>=C.limit)return;C.cursor++}}function u(){return _<=C.cursor}function c(){return f<=C.cursor}function a(){var e=C.limit-C.cursor;C.find_among_b(g,3)&&(C.cursor=C.limit-e,C.ket=C.cursor,C.cursor>C.limit_backward&&(C.cursor--,C.bra=C.cursor,C.slice_del()))}function l(){var e;w=!1,C.ket=C.cursor,C.eq_s_b(1,"e")&&(C.bra=C.cursor,u()&&(e=C.limit-C.cursor,C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-e,C.slice_del(),w=!0,a())))}function m(){var e;u()&&(e=C.limit-C.cursor,C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-e,C.eq_s_b(3,"gem")||(C.cursor=C.limit-e,C.slice_del(),a())))}function d(){var e,r,i,n,o,t,s=C.limit-C.cursor;if(C.ket=C.cursor,e=C.find_among_b(h,5))switch(C.bra=C.cursor,e){case 1:u()&&C.slice_from("heid");break;case 2:m();break;case 3:u()&&C.out_grouping_b(z,97,232)&&C.slice_del()}if(C.cursor=C.limit-s,l(),C.cursor=C.limit-s,C.ket=C.cursor,C.eq_s_b(4,"heid")&&(C.bra=C.cursor,c()&&(r=C.limit-C.cursor,C.eq_s_b(1,"c")||(C.cursor=C.limit-r,C.slice_del(),C.ket=C.cursor,C.eq_s_b(2,"en")&&(C.bra=C.cursor,m())))),C.cursor=C.limit-s,C.ket=C.cursor,e=C.find_among_b(k,6))switch(C.bra=C.cursor,e){case 1:if(c()){if(C.slice_del(),i=C.limit-C.cursor,C.ket=C.cursor,C.eq_s_b(2,"ig")&&(C.bra=C.cursor,c()&&(n=C.limit-C.cursor,!C.eq_s_b(1,"e")))){C.cursor=C.limit-n,C.slice_del();break}C.cursor=C.limit-i,a()}break;case 2:c()&&(o=C.limit-C.cursor,C.eq_s_b(1,"e")||(C.cursor=C.limit-o,C.slice_del()));break;case 3:c()&&(C.slice_del(),l());break;case 4:c()&&C.slice_del();break;case 5:c()&&w&&C.slice_del()}C.cursor=C.limit-s,C.out_grouping_b(j,73,232)&&(t=C.limit-C.cursor,C.find_among_b(v,4)&&C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-t,C.ket=C.cursor,C.cursor>C.limit_backward&&(C.cursor--,C.bra=C.cursor,C.slice_del())))}var f,_,w,b=[new r("",-1,6),new r("á",0,1),new r("ä",0,1),new r("é",0,2),new r("ë",0,2),new r("í",0,3),new r("ï",0,3),new r("ó",0,4),new r("ö",0,4),new r("ú",0,5),new r("ü",0,5)],p=[new r("",-1,3),new r("I",0,2),new r("Y",0,1)],g=[new r("dd",-1,-1),new r("kk",-1,-1),new r("tt",-1,-1)],h=[new r("ene",-1,2),new r("se",-1,3),new r("en",-1,2),new r("heden",2,1),new r("s",-1,3)],k=[new r("end",-1,1),new r("ig",-1,2),new r("ing",-1,1),new r("lijk",-1,3),new r("baar",-1,4),new r("bar",-1,5)],v=[new r("aa",-1,-1),new r("ee",-1,-1),new r("oo",-1,-1),new r("uu",-1,-1)],q=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],j=[1,0,0,17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],z=[17,67,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],C=new i;this.setCurrent=function(e){C.setCurrent(e)},this.getCurrent=function(){return C.getCurrent()},this.stem=function(){var r=C.cursor;return e(),C.cursor=r,o(),C.limit_backward=r,C.cursor=C.limit,d(),C.cursor=C.limit_backward,s(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.du.stemmer,"stemmer-du"),e.du.stopWordFilter=e.generateStopWordFilter(" aan al alles als altijd andere ben bij daar dan dat de der deze die dit doch doen door dus een eens en er ge geen geweest haar had heb hebben heeft hem het hier hij hoe hun iemand iets ik in is ja je kan kon kunnen maar me meer men met mij mijn moet na naar niet niets nog nu of om omdat onder ons ook op over reeds te tegen toch toen tot u uit uw van veel voor want waren was wat werd wezen wie wil worden wordt zal ze zelf zich zij zijn zo zonder zou".split(" ")),e.Pipeline.registerFunction(e.du.stopWordFilter,"stopWordFilter-du")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.es.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.es.min.js new file mode 100644 index 0000000000..2989d34265 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.es.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Spanish` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,s){"function"==typeof define&&define.amd?define(s):"object"==typeof exports?module.exports=s():s()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.es=function(){this.pipeline.reset(),this.pipeline.add(e.es.trimmer,e.es.stopWordFilter,e.es.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.es.stemmer))},e.es.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.es.trimmer=e.trimmerSupport.generateTrimmer(e.es.wordCharacters),e.Pipeline.registerFunction(e.es.trimmer,"trimmer-es"),e.es.stemmer=function(){var s=e.stemmerSupport.Among,r=e.stemmerSupport.SnowballProgram,n=new function(){function e(){if(A.out_grouping(x,97,252)){for(;!A.in_grouping(x,97,252);){if(A.cursor>=A.limit)return!0;A.cursor++}return!1}return!0}function n(){if(A.in_grouping(x,97,252)){var s=A.cursor;if(e()){if(A.cursor=s,!A.in_grouping(x,97,252))return!0;for(;!A.out_grouping(x,97,252);){if(A.cursor>=A.limit)return!0;A.cursor++}}return!1}return!0}function i(){var s,r=A.cursor;if(n()){if(A.cursor=r,!A.out_grouping(x,97,252))return;if(s=A.cursor,e()){if(A.cursor=s,!A.in_grouping(x,97,252)||A.cursor>=A.limit)return;A.cursor++}}g=A.cursor}function a(){for(;!A.in_grouping(x,97,252);){if(A.cursor>=A.limit)return!1;A.cursor++}for(;!A.out_grouping(x,97,252);){if(A.cursor>=A.limit)return!1;A.cursor++}return!0}function t(){var e=A.cursor;g=A.limit,p=g,v=g,i(),A.cursor=e,a()&&(p=A.cursor,a()&&(v=A.cursor))}function o(){for(var e;;){if(A.bra=A.cursor,e=A.find_among(k,6))switch(A.ket=A.cursor,e){case 1:A.slice_from("a");continue;case 2:A.slice_from("e");continue;case 3:A.slice_from("i");continue;case 4:A.slice_from("o");continue;case 5:A.slice_from("u");continue;case 6:if(A.cursor>=A.limit)break;A.cursor++;continue}break}}function u(){return g<=A.cursor}function w(){return p<=A.cursor}function c(){return v<=A.cursor}function m(){var e;if(A.ket=A.cursor,A.find_among_b(y,13)&&(A.bra=A.cursor,(e=A.find_among_b(q,11))&&u()))switch(e){case 1:A.bra=A.cursor,A.slice_from("iendo");break;case 2:A.bra=A.cursor,A.slice_from("ando");break;case 3:A.bra=A.cursor,A.slice_from("ar");break;case 4:A.bra=A.cursor,A.slice_from("er");break;case 5:A.bra=A.cursor,A.slice_from("ir");break;case 6:A.slice_del();break;case 7:A.eq_s_b(1,"u")&&A.slice_del()}}function l(e,s){if(!c())return!0;A.slice_del(),A.ket=A.cursor;var r=A.find_among_b(e,s);return r&&(A.bra=A.cursor,1==r&&c()&&A.slice_del()),!1}function d(e){return!c()||(A.slice_del(),A.ket=A.cursor,A.eq_s_b(2,e)&&(A.bra=A.cursor,c()&&A.slice_del()),!1)}function b(){var e;if(A.ket=A.cursor,e=A.find_among_b(S,46)){switch(A.bra=A.cursor,e){case 1:if(!c())return!1;A.slice_del();break;case 2:if(d("ic"))return!1;break;case 3:if(!c())return!1;A.slice_from("log");break;case 4:if(!c())return!1;A.slice_from("u");break;case 5:if(!c())return!1;A.slice_from("ente");break;case 6:if(!w())return!1;A.slice_del(),A.ket=A.cursor,e=A.find_among_b(C,4),e&&(A.bra=A.cursor,c()&&(A.slice_del(),1==e&&(A.ket=A.cursor,A.eq_s_b(2,"at")&&(A.bra=A.cursor,c()&&A.slice_del()))));break;case 7:if(l(P,3))return!1;break;case 8:if(l(F,3))return!1;break;case 9:if(d("at"))return!1}return!0}return!1}function f(){var e,s;if(A.cursor>=g&&(s=A.limit_backward,A.limit_backward=g,A.ket=A.cursor,e=A.find_among_b(W,12),A.limit_backward=s,e)){if(A.bra=A.cursor,1==e){if(!A.eq_s_b(1,"u"))return!1;A.slice_del()}return!0}return!1}function _(){var e,s,r,n;if(A.cursor>=g&&(s=A.limit_backward,A.limit_backward=g,A.ket=A.cursor,e=A.find_among_b(L,96),A.limit_backward=s,e))switch(A.bra=A.cursor,e){case 1:r=A.limit-A.cursor,A.eq_s_b(1,"u")?(n=A.limit-A.cursor,A.eq_s_b(1,"g")?A.cursor=A.limit-n:A.cursor=A.limit-r):A.cursor=A.limit-r,A.bra=A.cursor;case 2:A.slice_del()}}function h(){var e,s;if(A.ket=A.cursor,e=A.find_among_b(z,8))switch(A.bra=A.cursor,e){case 1:u()&&A.slice_del();break;case 2:u()&&(A.slice_del(),A.ket=A.cursor,A.eq_s_b(1,"u")&&(A.bra=A.cursor,s=A.limit-A.cursor,A.eq_s_b(1,"g")&&(A.cursor=A.limit-s,u()&&A.slice_del())))}}var v,p,g,k=[new s("",-1,6),new s("á",0,1),new s("é",0,2),new s("í",0,3),new s("ó",0,4),new s("ú",0,5)],y=[new s("la",-1,-1),new s("sela",0,-1),new s("le",-1,-1),new s("me",-1,-1),new s("se",-1,-1),new s("lo",-1,-1),new s("selo",5,-1),new s("las",-1,-1),new s("selas",7,-1),new s("les",-1,-1),new s("los",-1,-1),new s("selos",10,-1),new s("nos",-1,-1)],q=[new s("ando",-1,6),new s("iendo",-1,6),new s("yendo",-1,7),new s("ándo",-1,2),new s("iéndo",-1,1),new s("ar",-1,6),new s("er",-1,6),new s("ir",-1,6),new s("ár",-1,3),new s("ér",-1,4),new s("ír",-1,5)],C=[new s("ic",-1,-1),new s("ad",-1,-1),new s("os",-1,-1),new s("iv",-1,1)],P=[new s("able",-1,1),new s("ible",-1,1),new s("ante",-1,1)],F=[new s("ic",-1,1),new s("abil",-1,1),new s("iv",-1,1)],S=[new s("ica",-1,1),new s("ancia",-1,2),new s("encia",-1,5),new s("adora",-1,2),new s("osa",-1,1),new s("ista",-1,1),new s("iva",-1,9),new s("anza",-1,1),new s("logía",-1,3),new s("idad",-1,8),new s("able",-1,1),new s("ible",-1,1),new s("ante",-1,2),new s("mente",-1,7),new s("amente",13,6),new s("ación",-1,2),new s("ución",-1,4),new s("ico",-1,1),new s("ismo",-1,1),new s("oso",-1,1),new s("amiento",-1,1),new s("imiento",-1,1),new s("ivo",-1,9),new s("ador",-1,2),new s("icas",-1,1),new s("ancias",-1,2),new s("encias",-1,5),new s("adoras",-1,2),new s("osas",-1,1),new s("istas",-1,1),new s("ivas",-1,9),new s("anzas",-1,1),new s("logías",-1,3),new s("idades",-1,8),new s("ables",-1,1),new s("ibles",-1,1),new s("aciones",-1,2),new s("uciones",-1,4),new s("adores",-1,2),new s("antes",-1,2),new s("icos",-1,1),new s("ismos",-1,1),new s("osos",-1,1),new s("amientos",-1,1),new s("imientos",-1,1),new s("ivos",-1,9)],W=[new s("ya",-1,1),new s("ye",-1,1),new s("yan",-1,1),new s("yen",-1,1),new s("yeron",-1,1),new s("yendo",-1,1),new s("yo",-1,1),new s("yas",-1,1),new s("yes",-1,1),new s("yais",-1,1),new s("yamos",-1,1),new s("yó",-1,1)],L=[new s("aba",-1,2),new s("ada",-1,2),new s("ida",-1,2),new s("ara",-1,2),new s("iera",-1,2),new s("ía",-1,2),new s("aría",5,2),new s("ería",5,2),new s("iría",5,2),new s("ad",-1,2),new s("ed",-1,2),new s("id",-1,2),new s("ase",-1,2),new s("iese",-1,2),new s("aste",-1,2),new s("iste",-1,2),new s("an",-1,2),new s("aban",16,2),new s("aran",16,2),new s("ieran",16,2),new s("ían",16,2),new s("arían",20,2),new s("erían",20,2),new s("irían",20,2),new s("en",-1,1),new s("asen",24,2),new s("iesen",24,2),new s("aron",-1,2),new s("ieron",-1,2),new s("arán",-1,2),new s("erán",-1,2),new s("irán",-1,2),new s("ado",-1,2),new s("ido",-1,2),new s("ando",-1,2),new s("iendo",-1,2),new s("ar",-1,2),new s("er",-1,2),new s("ir",-1,2),new s("as",-1,2),new s("abas",39,2),new s("adas",39,2),new s("idas",39,2),new s("aras",39,2),new s("ieras",39,2),new s("ías",39,2),new s("arías",45,2),new s("erías",45,2),new s("irías",45,2),new s("es",-1,1),new s("ases",49,2),new s("ieses",49,2),new s("abais",-1,2),new s("arais",-1,2),new s("ierais",-1,2),new s("íais",-1,2),new s("aríais",55,2),new s("eríais",55,2),new s("iríais",55,2),new s("aseis",-1,2),new s("ieseis",-1,2),new s("asteis",-1,2),new s("isteis",-1,2),new s("áis",-1,2),new s("éis",-1,1),new s("aréis",64,2),new s("eréis",64,2),new s("iréis",64,2),new s("ados",-1,2),new s("idos",-1,2),new s("amos",-1,2),new s("ábamos",70,2),new s("áramos",70,2),new s("iéramos",70,2),new s("íamos",70,2),new s("aríamos",74,2),new s("eríamos",74,2),new s("iríamos",74,2),new s("emos",-1,1),new s("aremos",78,2),new s("eremos",78,2),new s("iremos",78,2),new s("ásemos",78,2),new s("iésemos",78,2),new s("imos",-1,2),new s("arás",-1,2),new s("erás",-1,2),new s("irás",-1,2),new s("ís",-1,2),new s("ará",-1,2),new s("erá",-1,2),new s("irá",-1,2),new s("aré",-1,2),new s("eré",-1,2),new s("iré",-1,2),new s("ió",-1,2)],z=[new s("a",-1,1),new s("e",-1,2),new s("o",-1,1),new s("os",-1,1),new s("á",-1,1),new s("é",-1,2),new s("í",-1,1),new s("ó",-1,1)],x=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,1,17,4,10],A=new r;this.setCurrent=function(e){A.setCurrent(e)},this.getCurrent=function(){return A.getCurrent()},this.stem=function(){var e=A.cursor;return t(),A.limit_backward=e,A.cursor=A.limit,m(),A.cursor=A.limit,b()||(A.cursor=A.limit,f()||(A.cursor=A.limit,_())),A.cursor=A.limit,h(),A.cursor=A.limit_backward,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.es.stemmer,"stemmer-es"),e.es.stopWordFilter=e.generateStopWordFilter("a al algo algunas algunos ante antes como con contra cual cuando de del desde donde durante e el ella ellas ellos en entre era erais eran eras eres es esa esas ese eso esos esta estaba estabais estaban estabas estad estada estadas estado estados estamos estando estar estaremos estará estarán estarás estaré estaréis estaría estaríais estaríamos estarían estarías estas este estemos esto estos estoy estuve estuviera estuvierais estuvieran estuvieras estuvieron estuviese estuvieseis estuviesen estuvieses estuvimos estuviste estuvisteis estuviéramos estuviésemos estuvo está estábamos estáis están estás esté estéis estén estés fue fuera fuerais fueran fueras fueron fuese fueseis fuesen fueses fui fuimos fuiste fuisteis fuéramos fuésemos ha habida habidas habido habidos habiendo habremos habrá habrán habrás habré habréis habría habríais habríamos habrían habrías habéis había habíais habíamos habían habías han has hasta hay haya hayamos hayan hayas hayáis he hemos hube hubiera hubierais hubieran hubieras hubieron hubiese hubieseis hubiesen hubieses hubimos hubiste hubisteis hubiéramos hubiésemos hubo la las le les lo los me mi mis mucho muchos muy más mí mía mías mío míos nada ni no nos nosotras nosotros nuestra nuestras nuestro nuestros o os otra otras otro otros para pero poco por porque que quien quienes qué se sea seamos sean seas seremos será serán serás seré seréis sería seríais seríamos serían serías seáis sido siendo sin sobre sois somos son soy su sus suya suyas suyo suyos sí también tanto te tendremos tendrá tendrán tendrás tendré tendréis tendría tendríais tendríamos tendrían tendrías tened tenemos tenga tengamos tengan tengas tengo tengáis tenida tenidas tenido tenidos teniendo tenéis tenía teníais teníamos tenían tenías ti tiene tienen tienes todo todos tu tus tuve tuviera tuvierais tuvieran tuvieras tuvieron tuviese tuvieseis tuviesen tuvieses tuvimos tuviste tuvisteis tuviéramos tuviésemos tuvo tuya tuyas tuyo tuyos tú un una uno unos vosotras vosotros vuestra vuestras vuestro vuestros y ya yo él éramos".split(" ")),e.Pipeline.registerFunction(e.es.stopWordFilter,"stopWordFilter-es")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.fi.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.fi.min.js new file mode 100644 index 0000000000..29f5dfcea8 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.fi.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Finnish` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(i,e){"function"==typeof define&&define.amd?define(e):"object"==typeof exports?module.exports=e():e()(i.lunr)}(this,function(){return function(i){if(void 0===i)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===i.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");i.fi=function(){this.pipeline.reset(),this.pipeline.add(i.fi.trimmer,i.fi.stopWordFilter,i.fi.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(i.fi.stemmer))},i.fi.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",i.fi.trimmer=i.trimmerSupport.generateTrimmer(i.fi.wordCharacters),i.Pipeline.registerFunction(i.fi.trimmer,"trimmer-fi"),i.fi.stemmer=function(){var e=i.stemmerSupport.Among,r=i.stemmerSupport.SnowballProgram,n=new function(){function i(){f=A.limit,d=f,n()||(f=A.cursor,n()||(d=A.cursor))}function n(){for(var i;;){if(i=A.cursor,A.in_grouping(W,97,246))break;if(A.cursor=i,i>=A.limit)return!0;A.cursor++}for(A.cursor=i;!A.out_grouping(W,97,246);){if(A.cursor>=A.limit)return!0;A.cursor++}return!1}function t(){return d<=A.cursor}function s(){var i,e;if(A.cursor>=f)if(e=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,i=A.find_among_b(h,10)){switch(A.bra=A.cursor,A.limit_backward=e,i){case 1:if(!A.in_grouping_b(x,97,246))return;break;case 2:if(!t())return}A.slice_del()}else A.limit_backward=e}function o(){var i,e,r;if(A.cursor>=f)if(e=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,i=A.find_among_b(v,9))switch(A.bra=A.cursor,A.limit_backward=e,i){case 1:r=A.limit-A.cursor,A.eq_s_b(1,"k")||(A.cursor=A.limit-r,A.slice_del());break;case 2:A.slice_del(),A.ket=A.cursor,A.eq_s_b(3,"kse")&&(A.bra=A.cursor,A.slice_from("ksi"));break;case 3:A.slice_del();break;case 4:A.find_among_b(p,6)&&A.slice_del();break;case 5:A.find_among_b(g,6)&&A.slice_del();break;case 6:A.find_among_b(j,2)&&A.slice_del()}else A.limit_backward=e}function l(){return A.find_among_b(q,7)}function a(){return A.eq_s_b(1,"i")&&A.in_grouping_b(L,97,246)}function u(){var i,e,r;if(A.cursor>=f)if(e=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,i=A.find_among_b(C,30)){switch(A.bra=A.cursor,A.limit_backward=e,i){case 1:if(!A.eq_s_b(1,"a"))return;break;case 2:case 9:if(!A.eq_s_b(1,"e"))return;break;case 3:if(!A.eq_s_b(1,"i"))return;break;case 4:if(!A.eq_s_b(1,"o"))return;break;case 5:if(!A.eq_s_b(1,"ä"))return;break;case 6:if(!A.eq_s_b(1,"ö"))return;break;case 7:if(r=A.limit-A.cursor,!l()&&(A.cursor=A.limit-r,!A.eq_s_b(2,"ie"))){A.cursor=A.limit-r;break}if(A.cursor=A.limit-r,A.cursor<=A.limit_backward){A.cursor=A.limit-r;break}A.cursor--,A.bra=A.cursor;break;case 8:if(!A.in_grouping_b(W,97,246)||!A.out_grouping_b(W,97,246))return}A.slice_del(),k=!0}else A.limit_backward=e}function c(){var i,e,r;if(A.cursor>=d)if(e=A.limit_backward,A.limit_backward=d,A.ket=A.cursor,i=A.find_among_b(P,14)){if(A.bra=A.cursor,A.limit_backward=e,1==i){if(r=A.limit-A.cursor,A.eq_s_b(2,"po"))return;A.cursor=A.limit-r}A.slice_del()}else A.limit_backward=e}function m(){var i;A.cursor>=f&&(i=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,A.find_among_b(F,2)?(A.bra=A.cursor,A.limit_backward=i,A.slice_del()):A.limit_backward=i)}function w(){var i,e,r,n,t,s;if(A.cursor>=f){if(e=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,A.eq_s_b(1,"t")&&(A.bra=A.cursor,r=A.limit-A.cursor,A.in_grouping_b(W,97,246)&&(A.cursor=A.limit-r,A.slice_del(),A.limit_backward=e,n=A.limit-A.cursor,A.cursor>=d&&(A.cursor=d,t=A.limit_backward,A.limit_backward=A.cursor,A.cursor=A.limit-n,A.ket=A.cursor,i=A.find_among_b(S,2))))){if(A.bra=A.cursor,A.limit_backward=t,1==i){if(s=A.limit-A.cursor,A.eq_s_b(2,"po"))return;A.cursor=A.limit-s}return void A.slice_del()}A.limit_backward=e}}function _(){var i,e,r,n;if(A.cursor>=f){for(i=A.limit_backward,A.limit_backward=f,e=A.limit-A.cursor,l()&&(A.cursor=A.limit-e,A.ket=A.cursor,A.cursor>A.limit_backward&&(A.cursor--,A.bra=A.cursor,A.slice_del())),A.cursor=A.limit-e,A.ket=A.cursor,A.in_grouping_b(y,97,228)&&(A.bra=A.cursor,A.out_grouping_b(W,97,246)&&A.slice_del()),A.cursor=A.limit-e,A.ket=A.cursor,A.eq_s_b(1,"j")&&(A.bra=A.cursor,r=A.limit-A.cursor,A.eq_s_b(1,"o")?A.slice_del():(A.cursor=A.limit-r,A.eq_s_b(1,"u")&&A.slice_del())),A.cursor=A.limit-e,A.ket=A.cursor,A.eq_s_b(1,"o")&&(A.bra=A.cursor,A.eq_s_b(1,"j")&&A.slice_del()),A.cursor=A.limit-e,A.limit_backward=i;;){if(n=A.limit-A.cursor,A.out_grouping_b(W,97,246)){A.cursor=A.limit-n;break}if(A.cursor=A.limit-n,A.cursor<=A.limit_backward)return;A.cursor--}A.ket=A.cursor,A.cursor>A.limit_backward&&(A.cursor--,A.bra=A.cursor,b=A.slice_to(),A.eq_v_b(b)&&A.slice_del())}}var k,b,d,f,h=[new e("pa",-1,1),new e("sti",-1,2),new e("kaan",-1,1),new e("han",-1,1),new e("kin",-1,1),new e("hän",-1,1),new e("kään",-1,1),new e("ko",-1,1),new e("pä",-1,1),new e("kö",-1,1)],p=[new e("lla",-1,-1),new e("na",-1,-1),new e("ssa",-1,-1),new e("ta",-1,-1),new e("lta",3,-1),new e("sta",3,-1)],g=[new e("llä",-1,-1),new e("nä",-1,-1),new e("ssä",-1,-1),new e("tä",-1,-1),new e("ltä",3,-1),new e("stä",3,-1)],j=[new e("lle",-1,-1),new e("ine",-1,-1)],v=[new e("nsa",-1,3),new e("mme",-1,3),new e("nne",-1,3),new e("ni",-1,2),new e("si",-1,1),new e("an",-1,4),new e("en",-1,6),new e("än",-1,5),new e("nsä",-1,3)],q=[new e("aa",-1,-1),new e("ee",-1,-1),new e("ii",-1,-1),new e("oo",-1,-1),new e("uu",-1,-1),new e("ää",-1,-1),new e("öö",-1,-1)],C=[new e("a",-1,8),new e("lla",0,-1),new e("na",0,-1),new e("ssa",0,-1),new e("ta",0,-1),new e("lta",4,-1),new e("sta",4,-1),new e("tta",4,9),new e("lle",-1,-1),new e("ine",-1,-1),new e("ksi",-1,-1),new e("n",-1,7),new e("han",11,1),new e("den",11,-1,a),new e("seen",11,-1,l),new e("hen",11,2),new e("tten",11,-1,a),new e("hin",11,3),new e("siin",11,-1,a),new e("hon",11,4),new e("hän",11,5),new e("hön",11,6),new e("ä",-1,8),new e("llä",22,-1),new e("nä",22,-1),new e("ssä",22,-1),new e("tä",22,-1),new e("ltä",26,-1),new e("stä",26,-1),new e("ttä",26,9)],P=[new e("eja",-1,-1),new e("mma",-1,1),new e("imma",1,-1),new e("mpa",-1,1),new e("impa",3,-1),new e("mmi",-1,1),new e("immi",5,-1),new e("mpi",-1,1),new e("impi",7,-1),new e("ejä",-1,-1),new e("mmä",-1,1),new e("immä",10,-1),new e("mpä",-1,1),new e("impä",12,-1)],F=[new e("i",-1,-1),new e("j",-1,-1)],S=[new e("mma",-1,1),new e("imma",0,-1)],y=[17,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,8],W=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,8,0,32],L=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,8,0,32],x=[17,97,24,1,0,0,0,0,0,0,0,0,0,0,0,0,8,0,32],A=new r;this.setCurrent=function(i){A.setCurrent(i)},this.getCurrent=function(){return A.getCurrent()},this.stem=function(){var e=A.cursor;return i(),k=!1,A.limit_backward=e,A.cursor=A.limit,s(),A.cursor=A.limit,o(),A.cursor=A.limit,u(),A.cursor=A.limit,c(),A.cursor=A.limit,k?(m(),A.cursor=A.limit):(A.cursor=A.limit,w(),A.cursor=A.limit),_(),!0}};return function(i){return"function"==typeof i.update?i.update(function(i){return n.setCurrent(i),n.stem(),n.getCurrent()}):(n.setCurrent(i),n.stem(),n.getCurrent())}}(),i.Pipeline.registerFunction(i.fi.stemmer,"stemmer-fi"),i.fi.stopWordFilter=i.generateStopWordFilter("ei eivät emme en et ette että he heidän heidät heihin heille heillä heiltä heissä heistä heitä hän häneen hänelle hänellä häneltä hänen hänessä hänestä hänet häntä itse ja johon joiden joihin joiksi joilla joille joilta joina joissa joista joita joka joksi jolla jolle jolta jona jonka jos jossa josta jota jotka kanssa keiden keihin keiksi keille keillä keiltä keinä keissä keistä keitä keneen keneksi kenelle kenellä keneltä kenen kenenä kenessä kenestä kenet ketkä ketkä ketä koska kuin kuka kun me meidän meidät meihin meille meillä meiltä meissä meistä meitä mihin miksi mikä mille millä miltä minkä minkä minua minulla minulle minulta minun minussa minusta minut minuun minä minä missä mistä mitkä mitä mukaan mutta ne niiden niihin niiksi niille niillä niiltä niin niin niinä niissä niistä niitä noiden noihin noiksi noilla noille noilta noin noina noissa noista noita nuo nyt näiden näihin näiksi näille näillä näiltä näinä näissä näistä näitä nämä ole olemme olen olet olette oli olimme olin olisi olisimme olisin olisit olisitte olisivat olit olitte olivat olla olleet ollut on ovat poikki se sekä sen siihen siinä siitä siksi sille sillä sillä siltä sinua sinulla sinulle sinulta sinun sinussa sinusta sinut sinuun sinä sinä sitä tai te teidän teidät teihin teille teillä teiltä teissä teistä teitä tuo tuohon tuoksi tuolla tuolle tuolta tuon tuona tuossa tuosta tuota tähän täksi tälle tällä tältä tämä tämän tänä tässä tästä tätä vaan vai vaikka yli".split(" ")),i.Pipeline.registerFunction(i.fi.stopWordFilter,"stopWordFilter-fi")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.fr.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.fr.min.js new file mode 100644 index 0000000000..68cd0094ae --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.fr.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `French` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.fr=function(){this.pipeline.reset(),this.pipeline.add(e.fr.trimmer,e.fr.stopWordFilter,e.fr.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.fr.stemmer))},e.fr.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.fr.trimmer=e.trimmerSupport.generateTrimmer(e.fr.wordCharacters),e.Pipeline.registerFunction(e.fr.trimmer,"trimmer-fr"),e.fr.stemmer=function(){var r=e.stemmerSupport.Among,s=e.stemmerSupport.SnowballProgram,i=new function(){function e(e,r,s){return!(!W.eq_s(1,e)||(W.ket=W.cursor,!W.in_grouping(F,97,251)))&&(W.slice_from(r),W.cursor=s,!0)}function i(e,r,s){return!!W.eq_s(1,e)&&(W.ket=W.cursor,W.slice_from(r),W.cursor=s,!0)}function n(){for(var r,s;;){if(r=W.cursor,W.in_grouping(F,97,251)){if(W.bra=W.cursor,s=W.cursor,e("u","U",r))continue;if(W.cursor=s,e("i","I",r))continue;if(W.cursor=s,i("y","Y",r))continue}if(W.cursor=r,W.bra=r,!e("y","Y",r)){if(W.cursor=r,W.eq_s(1,"q")&&(W.bra=W.cursor,i("u","U",r)))continue;if(W.cursor=r,r>=W.limit)return;W.cursor++}}}function t(){for(;!W.in_grouping(F,97,251);){if(W.cursor>=W.limit)return!0;W.cursor++}for(;!W.out_grouping(F,97,251);){if(W.cursor>=W.limit)return!0;W.cursor++}return!1}function u(){var e=W.cursor;if(q=W.limit,g=q,p=q,W.in_grouping(F,97,251)&&W.in_grouping(F,97,251)&&W.cursor=W.limit){W.cursor=q;break}W.cursor++}while(!W.in_grouping(F,97,251))}q=W.cursor,W.cursor=e,t()||(g=W.cursor,t()||(p=W.cursor))}function o(){for(var e,r;;){if(r=W.cursor,W.bra=r,!(e=W.find_among(h,4)))break;switch(W.ket=W.cursor,e){case 1:W.slice_from("i");break;case 2:W.slice_from("u");break;case 3:W.slice_from("y");break;case 4:if(W.cursor>=W.limit)return;W.cursor++}}}function c(){return q<=W.cursor}function a(){return g<=W.cursor}function l(){return p<=W.cursor}function w(){var e,r;if(W.ket=W.cursor,e=W.find_among_b(C,43)){switch(W.bra=W.cursor,e){case 1:if(!l())return!1;W.slice_del();break;case 2:if(!l())return!1;W.slice_del(),W.ket=W.cursor,W.eq_s_b(2,"ic")&&(W.bra=W.cursor,l()?W.slice_del():W.slice_from("iqU"));break;case 3:if(!l())return!1;W.slice_from("log");break;case 4:if(!l())return!1;W.slice_from("u");break;case 5:if(!l())return!1;W.slice_from("ent");break;case 6:if(!c())return!1;if(W.slice_del(),W.ket=W.cursor,e=W.find_among_b(z,6))switch(W.bra=W.cursor,e){case 1:l()&&(W.slice_del(),W.ket=W.cursor,W.eq_s_b(2,"at")&&(W.bra=W.cursor,l()&&W.slice_del()));break;case 2:l()?W.slice_del():a()&&W.slice_from("eux");break;case 3:l()&&W.slice_del();break;case 4:c()&&W.slice_from("i")}break;case 7:if(!l())return!1;if(W.slice_del(),W.ket=W.cursor,e=W.find_among_b(y,3))switch(W.bra=W.cursor,e){case 1:l()?W.slice_del():W.slice_from("abl");break;case 2:l()?W.slice_del():W.slice_from("iqU");break;case 3:l()&&W.slice_del()}break;case 8:if(!l())return!1;if(W.slice_del(),W.ket=W.cursor,W.eq_s_b(2,"at")&&(W.bra=W.cursor,l()&&(W.slice_del(),W.ket=W.cursor,W.eq_s_b(2,"ic")))){W.bra=W.cursor,l()?W.slice_del():W.slice_from("iqU");break}break;case 9:W.slice_from("eau");break;case 10:if(!a())return!1;W.slice_from("al");break;case 11:if(l())W.slice_del();else{if(!a())return!1;W.slice_from("eux")}break;case 12:if(!a()||!W.out_grouping_b(F,97,251))return!1;W.slice_del();break;case 13:return c()&&W.slice_from("ant"),!1;case 14:return c()&&W.slice_from("ent"),!1;case 15:return r=W.limit-W.cursor,W.in_grouping_b(F,97,251)&&c()&&(W.cursor=W.limit-r,W.slice_del()),!1}return!0}return!1}function f(){var e,r;if(W.cursor=q){if(s=W.limit_backward,W.limit_backward=q,W.ket=W.cursor,e=W.find_among_b(P,7))switch(W.bra=W.cursor,e){case 1:if(l()){if(i=W.limit-W.cursor,!W.eq_s_b(1,"s")&&(W.cursor=W.limit-i,!W.eq_s_b(1,"t")))break;W.slice_del()}break;case 2:W.slice_from("i");break;case 3:W.slice_del();break;case 4:W.eq_s_b(2,"gu")&&W.slice_del()}W.limit_backward=s}}function b(){var e=W.limit-W.cursor;W.find_among_b(U,5)&&(W.cursor=W.limit-e,W.ket=W.cursor,W.cursor>W.limit_backward&&(W.cursor--,W.bra=W.cursor,W.slice_del()))}function d(){for(var e,r=1;W.out_grouping_b(F,97,251);)r--;if(r<=0){if(W.ket=W.cursor,e=W.limit-W.cursor,!W.eq_s_b(1,"é")&&(W.cursor=W.limit-e,!W.eq_s_b(1,"è")))return;W.bra=W.cursor,W.slice_from("e")}}function k(){if(!w()&&(W.cursor=W.limit,!f()&&(W.cursor=W.limit,!m())))return W.cursor=W.limit,void _();W.cursor=W.limit,W.ket=W.cursor,W.eq_s_b(1,"Y")?(W.bra=W.cursor,W.slice_from("i")):(W.cursor=W.limit,W.eq_s_b(1,"ç")&&(W.bra=W.cursor,W.slice_from("c")))}var p,g,q,v=[new r("col",-1,-1),new r("par",-1,-1),new r("tap",-1,-1)],h=[new r("",-1,4),new r("I",0,1),new r("U",0,2),new r("Y",0,3)],z=[new r("iqU",-1,3),new r("abl",-1,3),new r("Ièr",-1,4),new r("ièr",-1,4),new r("eus",-1,2),new r("iv",-1,1)],y=[new r("ic",-1,2),new r("abil",-1,1),new r("iv",-1,3)],C=[new r("iqUe",-1,1),new r("atrice",-1,2),new r("ance",-1,1),new r("ence",-1,5),new r("logie",-1,3),new r("able",-1,1),new r("isme",-1,1),new r("euse",-1,11),new r("iste",-1,1),new r("ive",-1,8),new r("if",-1,8),new r("usion",-1,4),new r("ation",-1,2),new r("ution",-1,4),new r("ateur",-1,2),new r("iqUes",-1,1),new r("atrices",-1,2),new r("ances",-1,1),new r("ences",-1,5),new r("logies",-1,3),new r("ables",-1,1),new r("ismes",-1,1),new r("euses",-1,11),new r("istes",-1,1),new r("ives",-1,8),new r("ifs",-1,8),new r("usions",-1,4),new r("ations",-1,2),new r("utions",-1,4),new r("ateurs",-1,2),new r("ments",-1,15),new r("ements",30,6),new r("issements",31,12),new r("ités",-1,7),new r("ment",-1,15),new r("ement",34,6),new r("issement",35,12),new r("amment",34,13),new r("emment",34,14),new r("aux",-1,10),new r("eaux",39,9),new r("eux",-1,1),new r("ité",-1,7)],x=[new r("ira",-1,1),new r("ie",-1,1),new r("isse",-1,1),new r("issante",-1,1),new r("i",-1,1),new r("irai",4,1),new r("ir",-1,1),new r("iras",-1,1),new r("ies",-1,1),new r("îmes",-1,1),new r("isses",-1,1),new r("issantes",-1,1),new r("îtes",-1,1),new r("is",-1,1),new r("irais",13,1),new r("issais",13,1),new r("irions",-1,1),new r("issions",-1,1),new r("irons",-1,1),new r("issons",-1,1),new r("issants",-1,1),new r("it",-1,1),new r("irait",21,1),new r("issait",21,1),new r("issant",-1,1),new r("iraIent",-1,1),new r("issaIent",-1,1),new r("irent",-1,1),new r("issent",-1,1),new r("iront",-1,1),new r("ît",-1,1),new r("iriez",-1,1),new r("issiez",-1,1),new r("irez",-1,1),new r("issez",-1,1)],I=[new r("a",-1,3),new r("era",0,2),new r("asse",-1,3),new r("ante",-1,3),new r("ée",-1,2),new r("ai",-1,3),new r("erai",5,2),new r("er",-1,2),new r("as",-1,3),new r("eras",8,2),new r("âmes",-1,3),new r("asses",-1,3),new r("antes",-1,3),new r("âtes",-1,3),new r("ées",-1,2),new r("ais",-1,3),new r("erais",15,2),new r("ions",-1,1),new r("erions",17,2),new r("assions",17,3),new r("erons",-1,2),new r("ants",-1,3),new r("és",-1,2),new r("ait",-1,3),new r("erait",23,2),new r("ant",-1,3),new r("aIent",-1,3),new r("eraIent",26,2),new r("èrent",-1,2),new r("assent",-1,3),new r("eront",-1,2),new r("ât",-1,3),new r("ez",-1,2),new r("iez",32,2),new r("eriez",33,2),new r("assiez",33,3),new r("erez",32,2),new r("é",-1,2)],P=[new r("e",-1,3),new r("Ière",0,2),new r("ière",0,2),new r("ion",-1,1),new r("Ier",-1,2),new r("ier",-1,2),new r("ë",-1,4)],U=[new r("ell",-1,-1),new r("eill",-1,-1),new r("enn",-1,-1),new r("onn",-1,-1),new r("ett",-1,-1)],F=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,128,130,103,8,5],S=[1,65,20,0,0,0,0,0,0,0,0,0,0,0,0,0,128],W=new s;this.setCurrent=function(e){W.setCurrent(e)},this.getCurrent=function(){return W.getCurrent()},this.stem=function(){var e=W.cursor;return n(),W.cursor=e,u(),W.limit_backward=e,W.cursor=W.limit,k(),W.cursor=W.limit,b(),W.cursor=W.limit,d(),W.cursor=W.limit_backward,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.fr.stemmer,"stemmer-fr"),e.fr.stopWordFilter=e.generateStopWordFilter("ai aie aient aies ait as au aura aurai auraient aurais aurait auras aurez auriez aurions aurons auront aux avaient avais avait avec avez aviez avions avons ayant ayez ayons c ce ceci celà ces cet cette d dans de des du elle en es est et eu eue eues eurent eus eusse eussent eusses eussiez eussions eut eux eûmes eût eûtes furent fus fusse fussent fusses fussiez fussions fut fûmes fût fûtes ici il ils j je l la le les leur leurs lui m ma mais me mes moi mon même n ne nos notre nous on ont ou par pas pour qu que quel quelle quelles quels qui s sa sans se sera serai seraient serais serait seras serez seriez serions serons seront ses soi soient sois soit sommes son sont soyez soyons suis sur t ta te tes toi ton tu un une vos votre vous y à étaient étais était étant étiez étions été étée étées étés êtes".split(" ")),e.Pipeline.registerFunction(e.fr.stopWordFilter,"stopWordFilter-fr")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.hu.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.hu.min.js new file mode 100644 index 0000000000..ed9d909f73 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.hu.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Hungarian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,n){"function"==typeof define&&define.amd?define(n):"object"==typeof exports?module.exports=n():n()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.hu=function(){this.pipeline.reset(),this.pipeline.add(e.hu.trimmer,e.hu.stopWordFilter,e.hu.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.hu.stemmer))},e.hu.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.hu.trimmer=e.trimmerSupport.generateTrimmer(e.hu.wordCharacters),e.Pipeline.registerFunction(e.hu.trimmer,"trimmer-hu"),e.hu.stemmer=function(){var n=e.stemmerSupport.Among,r=e.stemmerSupport.SnowballProgram,i=new function(){function e(){var e,n=L.cursor;if(d=L.limit,L.in_grouping(W,97,252))for(;;){if(e=L.cursor,L.out_grouping(W,97,252))return L.cursor=e,L.find_among(g,8)||(L.cursor=e,e=L.limit)return void(d=e);L.cursor++}if(L.cursor=n,L.out_grouping(W,97,252)){for(;!L.in_grouping(W,97,252);){if(L.cursor>=L.limit)return;L.cursor++}d=L.cursor}}function i(){return d<=L.cursor}function a(){var e;if(L.ket=L.cursor,(e=L.find_among_b(h,2))&&(L.bra=L.cursor,i()))switch(e){case 1:L.slice_from("a");break;case 2:L.slice_from("e")}}function t(){var e=L.limit-L.cursor;return!!L.find_among_b(p,23)&&(L.cursor=L.limit-e,!0)}function s(){if(L.cursor>L.limit_backward){L.cursor--,L.ket=L.cursor;var e=L.cursor-1;L.limit_backward<=e&&e<=L.limit&&(L.cursor=e,L.bra=e,L.slice_del())}}function c(){var e;if(L.ket=L.cursor,(e=L.find_among_b(_,2))&&(L.bra=L.cursor,i())){if((1==e||2==e)&&!t())return;L.slice_del(),s()}}function o(){L.ket=L.cursor,L.find_among_b(v,44)&&(L.bra=L.cursor,i()&&(L.slice_del(),a()))}function w(){var e;if(L.ket=L.cursor,(e=L.find_among_b(z,3))&&(L.bra=L.cursor,i()))switch(e){case 1:L.slice_from("e");break;case 2:case 3:L.slice_from("a")}}function l(){var e;if(L.ket=L.cursor,(e=L.find_among_b(y,6))&&(L.bra=L.cursor,i()))switch(e){case 1:case 2:L.slice_del();break;case 3:L.slice_from("a");break;case 4:L.slice_from("e")}}function u(){var e;if(L.ket=L.cursor,(e=L.find_among_b(j,2))&&(L.bra=L.cursor,i())){if((1==e||2==e)&&!t())return;L.slice_del(),s()}}function m(){var e;if(L.ket=L.cursor,(e=L.find_among_b(C,7))&&(L.bra=L.cursor,i()))switch(e){case 1:L.slice_from("a");break;case 2:L.slice_from("e");break;case 3:case 4:case 5:case 6:case 7:L.slice_del()}}function k(){var e;if(L.ket=L.cursor,(e=L.find_among_b(P,12))&&(L.bra=L.cursor,i()))switch(e){case 1:case 4:case 7:case 9:L.slice_del();break;case 2:case 5:case 8:L.slice_from("e");break;case 3:case 6:L.slice_from("a")}}function f(){var e;if(L.ket=L.cursor,(e=L.find_among_b(F,31))&&(L.bra=L.cursor,i()))switch(e){case 1:case 4:case 7:case 8:case 9:case 12:case 13:case 16:case 17:case 18:L.slice_del();break;case 2:case 5:case 10:case 14:case 19:L.slice_from("a");break;case 3:case 6:case 11:case 15:case 20:L.slice_from("e")}}function b(){var e;if(L.ket=L.cursor,(e=L.find_among_b(S,42))&&(L.bra=L.cursor,i()))switch(e){case 1:case 4:case 5:case 6:case 9:case 10:case 11:case 14:case 15:case 16:case 17:case 20:case 21:case 24:case 25:case 26:case 29:L.slice_del();break;case 2:case 7:case 12:case 18:case 22:case 27:L.slice_from("a");break;case 3:case 8:case 13:case 19:case 23:case 28:L.slice_from("e")}}var d,g=[new n("cs",-1,-1),new n("dzs",-1,-1),new n("gy",-1,-1),new n("ly",-1,-1),new n("ny",-1,-1),new n("sz",-1,-1),new n("ty",-1,-1),new n("zs",-1,-1)],h=[new n("á",-1,1),new n("é",-1,2)],p=[new n("bb",-1,-1),new n("cc",-1,-1),new n("dd",-1,-1),new n("ff",-1,-1),new n("gg",-1,-1),new n("jj",-1,-1),new n("kk",-1,-1),new n("ll",-1,-1),new n("mm",-1,-1),new n("nn",-1,-1),new n("pp",-1,-1),new n("rr",-1,-1),new n("ccs",-1,-1),new n("ss",-1,-1),new n("zzs",-1,-1),new n("tt",-1,-1),new n("vv",-1,-1),new n("ggy",-1,-1),new n("lly",-1,-1),new n("nny",-1,-1),new n("tty",-1,-1),new n("ssz",-1,-1),new n("zz",-1,-1)],_=[new n("al",-1,1),new n("el",-1,2)],v=[new n("ba",-1,-1),new n("ra",-1,-1),new n("be",-1,-1),new n("re",-1,-1),new n("ig",-1,-1),new n("nak",-1,-1),new n("nek",-1,-1),new n("val",-1,-1),new n("vel",-1,-1),new n("ul",-1,-1),new n("nál",-1,-1),new n("nél",-1,-1),new n("ból",-1,-1),new n("ról",-1,-1),new n("tól",-1,-1),new n("bõl",-1,-1),new n("rõl",-1,-1),new n("tõl",-1,-1),new n("ül",-1,-1),new n("n",-1,-1),new n("an",19,-1),new n("ban",20,-1),new n("en",19,-1),new n("ben",22,-1),new n("képpen",22,-1),new n("on",19,-1),new n("ön",19,-1),new n("képp",-1,-1),new n("kor",-1,-1),new n("t",-1,-1),new n("at",29,-1),new n("et",29,-1),new n("ként",29,-1),new n("anként",32,-1),new n("enként",32,-1),new n("onként",32,-1),new n("ot",29,-1),new n("ért",29,-1),new n("öt",29,-1),new n("hez",-1,-1),new n("hoz",-1,-1),new n("höz",-1,-1),new n("vá",-1,-1),new n("vé",-1,-1)],z=[new n("án",-1,2),new n("én",-1,1),new n("ánként",-1,3)],y=[new n("stul",-1,2),new n("astul",0,1),new n("ástul",0,3),new n("stül",-1,2),new n("estül",3,1),new n("éstül",3,4)],j=[new n("á",-1,1),new n("é",-1,2)],C=[new n("k",-1,7),new n("ak",0,4),new n("ek",0,6),new n("ok",0,5),new n("ák",0,1),new n("ék",0,2),new n("ök",0,3)],P=[new n("éi",-1,7),new n("áéi",0,6),new n("ééi",0,5),new n("é",-1,9),new n("ké",3,4),new n("aké",4,1),new n("eké",4,1),new n("oké",4,1),new n("áké",4,3),new n("éké",4,2),new n("öké",4,1),new n("éé",3,8)],F=[new n("a",-1,18),new n("ja",0,17),new n("d",-1,16),new n("ad",2,13),new n("ed",2,13),new n("od",2,13),new n("ád",2,14),new n("éd",2,15),new n("öd",2,13),new n("e",-1,18),new n("je",9,17),new n("nk",-1,4),new n("unk",11,1),new n("ánk",11,2),new n("énk",11,3),new n("ünk",11,1),new n("uk",-1,8),new n("juk",16,7),new n("ájuk",17,5),new n("ük",-1,8),new n("jük",19,7),new n("éjük",20,6),new n("m",-1,12),new n("am",22,9),new n("em",22,9),new n("om",22,9),new n("ám",22,10),new n("ém",22,11),new n("o",-1,18),new n("á",-1,19),new n("é",-1,20)],S=[new n("id",-1,10),new n("aid",0,9),new n("jaid",1,6),new n("eid",0,9),new n("jeid",3,6),new n("áid",0,7),new n("éid",0,8),new n("i",-1,15),new n("ai",7,14),new n("jai",8,11),new n("ei",7,14),new n("jei",10,11),new n("ái",7,12),new n("éi",7,13),new n("itek",-1,24),new n("eitek",14,21),new n("jeitek",15,20),new n("éitek",14,23),new n("ik",-1,29),new n("aik",18,26),new n("jaik",19,25),new n("eik",18,26),new n("jeik",21,25),new n("áik",18,27),new n("éik",18,28),new n("ink",-1,20),new n("aink",25,17),new n("jaink",26,16),new n("eink",25,17),new n("jeink",28,16),new n("áink",25,18),new n("éink",25,19),new n("aitok",-1,21),new n("jaitok",32,20),new n("áitok",-1,22),new n("im",-1,5),new n("aim",35,4),new n("jaim",36,1),new n("eim",35,4),new n("jeim",38,1),new n("áim",35,2),new n("éim",35,3)],W=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,1,17,52,14],L=new r;this.setCurrent=function(e){L.setCurrent(e)},this.getCurrent=function(){return L.getCurrent()},this.stem=function(){var n=L.cursor;return e(),L.limit_backward=n,L.cursor=L.limit,c(),L.cursor=L.limit,o(),L.cursor=L.limit,w(),L.cursor=L.limit,l(),L.cursor=L.limit,u(),L.cursor=L.limit,k(),L.cursor=L.limit,f(),L.cursor=L.limit,b(),L.cursor=L.limit,m(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.hu.stemmer,"stemmer-hu"),e.hu.stopWordFilter=e.generateStopWordFilter("a abban ahhoz ahogy ahol aki akik akkor alatt amely amelyek amelyekben amelyeket amelyet amelynek ami amikor amit amolyan amíg annak arra arról az azok azon azonban azt aztán azután azzal azért be belül benne bár cikk cikkek cikkeket csak de e ebben eddig egy egyes egyetlen egyik egyre egyéb egész ehhez ekkor el ellen elsõ elég elõ elõször elõtt emilyen ennek erre ez ezek ezen ezt ezzel ezért fel felé hanem hiszen hogy hogyan igen ill ill. illetve ilyen ilyenkor ismét ison itt jobban jó jól kell kellett keressünk keresztül ki kívül között közül legalább legyen lehet lehetett lenne lenni lesz lett maga magát majd majd meg mellett mely melyek mert mi mikor milyen minden mindenki mindent mindig mint mintha mit mivel miért most már más másik még míg nagy nagyobb nagyon ne nekem neki nem nincs néha néhány nélkül olyan ott pedig persze rá s saját sem semmi sok sokat sokkal szemben szerint szinte számára talán tehát teljes tovább továbbá több ugyanis utolsó után utána vagy vagyis vagyok valaki valami valamint való van vannak vele vissza viszont volna volt voltak voltam voltunk által általában át én éppen és így õ õk õket össze úgy új újabb újra".split(" ")),e.Pipeline.registerFunction(e.hu.stopWordFilter,"stopWordFilter-hu")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.it.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.it.min.js new file mode 100644 index 0000000000..344b6a3c0c --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.it.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Italian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.it=function(){this.pipeline.reset(),this.pipeline.add(e.it.trimmer,e.it.stopWordFilter,e.it.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.it.stemmer))},e.it.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.it.trimmer=e.trimmerSupport.generateTrimmer(e.it.wordCharacters),e.Pipeline.registerFunction(e.it.trimmer,"trimmer-it"),e.it.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){function e(e,r,n){return!(!x.eq_s(1,e)||(x.ket=x.cursor,!x.in_grouping(L,97,249)))&&(x.slice_from(r),x.cursor=n,!0)}function i(){for(var r,n,i,o,t=x.cursor;;){if(x.bra=x.cursor,r=x.find_among(h,7))switch(x.ket=x.cursor,r){case 1:x.slice_from("à");continue;case 2:x.slice_from("è");continue;case 3:x.slice_from("ì");continue;case 4:x.slice_from("ò");continue;case 5:x.slice_from("ù");continue;case 6:x.slice_from("qU");continue;case 7:if(x.cursor>=x.limit)break;x.cursor++;continue}break}for(x.cursor=t;;)for(n=x.cursor;;){if(i=x.cursor,x.in_grouping(L,97,249)){if(x.bra=x.cursor,o=x.cursor,e("u","U",i))break;if(x.cursor=o,e("i","I",i))break}if(x.cursor=i,x.cursor>=x.limit)return void(x.cursor=n);x.cursor++}}function o(e){if(x.cursor=e,!x.in_grouping(L,97,249))return!1;for(;!x.out_grouping(L,97,249);){if(x.cursor>=x.limit)return!1;x.cursor++}return!0}function t(){if(x.in_grouping(L,97,249)){var e=x.cursor;if(x.out_grouping(L,97,249)){for(;!x.in_grouping(L,97,249);){if(x.cursor>=x.limit)return o(e);x.cursor++}return!0}return o(e)}return!1}function s(){var e,r=x.cursor;if(!t()){if(x.cursor=r,!x.out_grouping(L,97,249))return;if(e=x.cursor,x.out_grouping(L,97,249)){for(;!x.in_grouping(L,97,249);){if(x.cursor>=x.limit)return x.cursor=e,void(x.in_grouping(L,97,249)&&x.cursor=x.limit)return;x.cursor++}k=x.cursor}function a(){for(;!x.in_grouping(L,97,249);){if(x.cursor>=x.limit)return!1;x.cursor++}for(;!x.out_grouping(L,97,249);){if(x.cursor>=x.limit)return!1;x.cursor++}return!0}function u(){var e=x.cursor;k=x.limit,p=k,g=k,s(),x.cursor=e,a()&&(p=x.cursor,a()&&(g=x.cursor))}function c(){for(var e;;){if(x.bra=x.cursor,!(e=x.find_among(q,3)))break;switch(x.ket=x.cursor,e){case 1:x.slice_from("i");break;case 2:x.slice_from("u");break;case 3:if(x.cursor>=x.limit)return;x.cursor++}}}function w(){return k<=x.cursor}function l(){return p<=x.cursor}function m(){return g<=x.cursor}function f(){var e;if(x.ket=x.cursor,x.find_among_b(C,37)&&(x.bra=x.cursor,(e=x.find_among_b(z,5))&&w()))switch(e){case 1:x.slice_del();break;case 2:x.slice_from("e")}}function v(){var e;if(x.ket=x.cursor,!(e=x.find_among_b(S,51)))return!1;switch(x.bra=x.cursor,e){case 1:if(!m())return!1;x.slice_del();break;case 2:if(!m())return!1;x.slice_del(),x.ket=x.cursor,x.eq_s_b(2,"ic")&&(x.bra=x.cursor,m()&&x.slice_del());break;case 3:if(!m())return!1;x.slice_from("log");break;case 4:if(!m())return!1;x.slice_from("u");break;case 5:if(!m())return!1;x.slice_from("ente");break;case 6:if(!w())return!1;x.slice_del();break;case 7:if(!l())return!1;x.slice_del(),x.ket=x.cursor,e=x.find_among_b(P,4),e&&(x.bra=x.cursor,m()&&(x.slice_del(),1==e&&(x.ket=x.cursor,x.eq_s_b(2,"at")&&(x.bra=x.cursor,m()&&x.slice_del()))));break;case 8:if(!m())return!1;x.slice_del(),x.ket=x.cursor,e=x.find_among_b(F,3),e&&(x.bra=x.cursor,1==e&&m()&&x.slice_del());break;case 9:if(!m())return!1;x.slice_del(),x.ket=x.cursor,x.eq_s_b(2,"at")&&(x.bra=x.cursor,m()&&(x.slice_del(),x.ket=x.cursor,x.eq_s_b(2,"ic")&&(x.bra=x.cursor,m()&&x.slice_del())))}return!0}function b(){var e,r;x.cursor>=k&&(r=x.limit_backward,x.limit_backward=k,x.ket=x.cursor,e=x.find_among_b(W,87),e&&(x.bra=x.cursor,1==e&&x.slice_del()),x.limit_backward=r)}function d(){var e=x.limit-x.cursor;if(x.ket=x.cursor,x.in_grouping_b(y,97,242)&&(x.bra=x.cursor,w()&&(x.slice_del(),x.ket=x.cursor,x.eq_s_b(1,"i")&&(x.bra=x.cursor,w()))))return void x.slice_del();x.cursor=x.limit-e}function _(){d(),x.ket=x.cursor,x.eq_s_b(1,"h")&&(x.bra=x.cursor,x.in_grouping_b(U,99,103)&&w()&&x.slice_del())}var g,p,k,h=[new r("",-1,7),new r("qu",0,6),new r("á",0,1),new r("é",0,2),new r("í",0,3),new r("ó",0,4),new r("ú",0,5)],q=[new r("",-1,3),new r("I",0,1),new r("U",0,2)],C=[new r("la",-1,-1),new r("cela",0,-1),new r("gliela",0,-1),new r("mela",0,-1),new r("tela",0,-1),new r("vela",0,-1),new r("le",-1,-1),new r("cele",6,-1),new r("gliele",6,-1),new r("mele",6,-1),new r("tele",6,-1),new r("vele",6,-1),new r("ne",-1,-1),new r("cene",12,-1),new r("gliene",12,-1),new r("mene",12,-1),new r("sene",12,-1),new r("tene",12,-1),new r("vene",12,-1),new r("ci",-1,-1),new r("li",-1,-1),new r("celi",20,-1),new r("glieli",20,-1),new r("meli",20,-1),new r("teli",20,-1),new r("veli",20,-1),new r("gli",20,-1),new r("mi",-1,-1),new r("si",-1,-1),new r("ti",-1,-1),new r("vi",-1,-1),new r("lo",-1,-1),new r("celo",31,-1),new r("glielo",31,-1),new r("melo",31,-1),new r("telo",31,-1),new r("velo",31,-1)],z=[new r("ando",-1,1),new r("endo",-1,1),new r("ar",-1,2),new r("er",-1,2),new r("ir",-1,2)],P=[new r("ic",-1,-1),new r("abil",-1,-1),new r("os",-1,-1),new r("iv",-1,1)],F=[new r("ic",-1,1),new r("abil",-1,1),new r("iv",-1,1)],S=[new r("ica",-1,1),new r("logia",-1,3),new r("osa",-1,1),new r("ista",-1,1),new r("iva",-1,9),new r("anza",-1,1),new r("enza",-1,5),new r("ice",-1,1),new r("atrice",7,1),new r("iche",-1,1),new r("logie",-1,3),new r("abile",-1,1),new r("ibile",-1,1),new r("usione",-1,4),new r("azione",-1,2),new r("uzione",-1,4),new r("atore",-1,2),new r("ose",-1,1),new r("ante",-1,1),new r("mente",-1,1),new r("amente",19,7),new r("iste",-1,1),new r("ive",-1,9),new r("anze",-1,1),new r("enze",-1,5),new r("ici",-1,1),new r("atrici",25,1),new r("ichi",-1,1),new r("abili",-1,1),new r("ibili",-1,1),new r("ismi",-1,1),new r("usioni",-1,4),new r("azioni",-1,2),new r("uzioni",-1,4),new r("atori",-1,2),new r("osi",-1,1),new r("anti",-1,1),new r("amenti",-1,6),new r("imenti",-1,6),new r("isti",-1,1),new r("ivi",-1,9),new r("ico",-1,1),new r("ismo",-1,1),new r("oso",-1,1),new r("amento",-1,6),new r("imento",-1,6),new r("ivo",-1,9),new r("ità",-1,8),new r("istà",-1,1),new r("istè",-1,1),new r("istì",-1,1)],W=[new r("isca",-1,1),new r("enda",-1,1),new r("ata",-1,1),new r("ita",-1,1),new r("uta",-1,1),new r("ava",-1,1),new r("eva",-1,1),new r("iva",-1,1),new r("erebbe",-1,1),new r("irebbe",-1,1),new r("isce",-1,1),new r("ende",-1,1),new r("are",-1,1),new r("ere",-1,1),new r("ire",-1,1),new r("asse",-1,1),new r("ate",-1,1),new r("avate",16,1),new r("evate",16,1),new r("ivate",16,1),new r("ete",-1,1),new r("erete",20,1),new r("irete",20,1),new r("ite",-1,1),new r("ereste",-1,1),new r("ireste",-1,1),new r("ute",-1,1),new r("erai",-1,1),new r("irai",-1,1),new r("isci",-1,1),new r("endi",-1,1),new r("erei",-1,1),new r("irei",-1,1),new r("assi",-1,1),new r("ati",-1,1),new r("iti",-1,1),new r("eresti",-1,1),new r("iresti",-1,1),new r("uti",-1,1),new r("avi",-1,1),new r("evi",-1,1),new r("ivi",-1,1),new r("isco",-1,1),new r("ando",-1,1),new r("endo",-1,1),new r("Yamo",-1,1),new r("iamo",-1,1),new r("avamo",-1,1),new r("evamo",-1,1),new r("ivamo",-1,1),new r("eremo",-1,1),new r("iremo",-1,1),new r("assimo",-1,1),new r("ammo",-1,1),new r("emmo",-1,1),new r("eremmo",54,1),new r("iremmo",54,1),new r("immo",-1,1),new r("ano",-1,1),new r("iscano",58,1),new r("avano",58,1),new r("evano",58,1),new r("ivano",58,1),new r("eranno",-1,1),new r("iranno",-1,1),new r("ono",-1,1),new r("iscono",65,1),new r("arono",65,1),new r("erono",65,1),new r("irono",65,1),new r("erebbero",-1,1),new r("irebbero",-1,1),new r("assero",-1,1),new r("essero",-1,1),new r("issero",-1,1),new r("ato",-1,1),new r("ito",-1,1),new r("uto",-1,1),new r("avo",-1,1),new r("evo",-1,1),new r("ivo",-1,1),new r("ar",-1,1),new r("ir",-1,1),new r("erà",-1,1),new r("irà",-1,1),new r("erò",-1,1),new r("irò",-1,1)],L=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,128,128,8,2,1],y=[17,65,0,0,0,0,0,0,0,0,0,0,0,0,0,128,128,8,2],U=[17],x=new n;this.setCurrent=function(e){x.setCurrent(e)},this.getCurrent=function(){return x.getCurrent()},this.stem=function(){var e=x.cursor;return i(),x.cursor=e,u(),x.limit_backward=e,x.cursor=x.limit,f(),x.cursor=x.limit,v()||(x.cursor=x.limit,b()),x.cursor=x.limit,_(),x.cursor=x.limit_backward,c(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.it.stemmer,"stemmer-it"),e.it.stopWordFilter=e.generateStopWordFilter("a abbia abbiamo abbiano abbiate ad agl agli ai al all alla alle allo anche avemmo avendo avesse avessero avessi avessimo aveste avesti avete aveva avevamo avevano avevate avevi avevo avrai avranno avrebbe avrebbero avrei avremmo avremo avreste avresti avrete avrà avrò avuta avute avuti avuto c che chi ci coi col come con contro cui da dagl dagli dai dal dall dalla dalle dallo degl degli dei del dell della delle dello di dov dove e ebbe ebbero ebbi ed era erano eravamo eravate eri ero essendo faccia facciamo facciano facciate faccio facemmo facendo facesse facessero facessi facessimo faceste facesti faceva facevamo facevano facevate facevi facevo fai fanno farai faranno farebbe farebbero farei faremmo faremo fareste faresti farete farà farò fece fecero feci fosse fossero fossi fossimo foste fosti fu fui fummo furono gli ha hai hanno ho i il in io l la le lei li lo loro lui ma mi mia mie miei mio ne negl negli nei nel nell nella nelle nello noi non nostra nostre nostri nostro o per perché più quale quanta quante quanti quanto quella quelle quelli quello questa queste questi questo sarai saranno sarebbe sarebbero sarei saremmo saremo sareste saresti sarete sarà sarò se sei si sia siamo siano siate siete sono sta stai stando stanno starai staranno starebbe starebbero starei staremmo staremo stareste staresti starete starà starò stava stavamo stavano stavate stavi stavo stemmo stesse stessero stessi stessimo steste stesti stette stettero stetti stia stiamo stiano stiate sto su sua sue sugl sugli sui sul sull sulla sulle sullo suo suoi ti tra tu tua tue tuo tuoi tutti tutto un una uno vi voi vostra vostre vostri vostro è".split(" ")),e.Pipeline.registerFunction(e.it.stopWordFilter,"stopWordFilter-it")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.ja.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.ja.min.js new file mode 100644 index 0000000000..5f254ebe91 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.ja.min.js @@ -0,0 +1 @@ +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r="2"==e.version[0];e.ja=function(){this.pipeline.reset(),this.pipeline.add(e.ja.trimmer,e.ja.stopWordFilter,e.ja.stemmer),r?this.tokenizer=e.ja.tokenizer:(e.tokenizer&&(e.tokenizer=e.ja.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.ja.tokenizer))};var t=new e.TinySegmenter;e.ja.tokenizer=function(i){var n,o,s,p,a,u,m,l,c,f;if(!arguments.length||null==i||void 0==i)return[];if(Array.isArray(i))return i.map(function(t){return r?new e.Token(t.toLowerCase()):t.toLowerCase()});for(o=i.toString().toLowerCase().replace(/^\s+/,""),n=o.length-1;n>=0;n--)if(/\S/.test(o.charAt(n))){o=o.substring(0,n+1);break}for(a=[],s=o.length,c=0,l=0;c<=s;c++)if(u=o.charAt(c),m=c-l,u.match(/\s/)||c==s){if(m>0)for(p=t.segment(o.slice(l,c)).filter(function(e){return!!e}),f=l,n=0;n=C.limit)break;C.cursor++;continue}break}for(C.cursor=o,C.bra=o,C.eq_s(1,"y")?(C.ket=C.cursor,C.slice_from("Y")):C.cursor=o;;)if(e=C.cursor,C.in_grouping(q,97,232)){if(i=C.cursor,C.bra=i,C.eq_s(1,"i"))C.ket=C.cursor,C.in_grouping(q,97,232)&&(C.slice_from("I"),C.cursor=e);else if(C.cursor=i,C.eq_s(1,"y"))C.ket=C.cursor,C.slice_from("Y"),C.cursor=e;else if(n(e))break}else if(n(e))break}function n(r){return C.cursor=r,r>=C.limit||(C.cursor++,!1)}function o(){_=C.limit,d=_,t()||(_=C.cursor,_<3&&(_=3),t()||(d=C.cursor))}function t(){for(;!C.in_grouping(q,97,232);){if(C.cursor>=C.limit)return!0;C.cursor++}for(;!C.out_grouping(q,97,232);){if(C.cursor>=C.limit)return!0;C.cursor++}return!1}function s(){for(var r;;)if(C.bra=C.cursor,r=C.find_among(p,3))switch(C.ket=C.cursor,r){case 1:C.slice_from("y");break;case 2:C.slice_from("i");break;case 3:if(C.cursor>=C.limit)return;C.cursor++}}function u(){return _<=C.cursor}function c(){return d<=C.cursor}function a(){var r=C.limit-C.cursor;C.find_among_b(g,3)&&(C.cursor=C.limit-r,C.ket=C.cursor,C.cursor>C.limit_backward&&(C.cursor--,C.bra=C.cursor,C.slice_del()))}function l(){var r;w=!1,C.ket=C.cursor,C.eq_s_b(1,"e")&&(C.bra=C.cursor,u()&&(r=C.limit-C.cursor,C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-r,C.slice_del(),w=!0,a())))}function m(){var r;u()&&(r=C.limit-C.cursor,C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-r,C.eq_s_b(3,"gem")||(C.cursor=C.limit-r,C.slice_del(),a())))}function f(){var r,e,i,n,o,t,s=C.limit-C.cursor;if(C.ket=C.cursor,r=C.find_among_b(h,5))switch(C.bra=C.cursor,r){case 1:u()&&C.slice_from("heid");break;case 2:m();break;case 3:u()&&C.out_grouping_b(j,97,232)&&C.slice_del()}if(C.cursor=C.limit-s,l(),C.cursor=C.limit-s,C.ket=C.cursor,C.eq_s_b(4,"heid")&&(C.bra=C.cursor,c()&&(e=C.limit-C.cursor,C.eq_s_b(1,"c")||(C.cursor=C.limit-e,C.slice_del(),C.ket=C.cursor,C.eq_s_b(2,"en")&&(C.bra=C.cursor,m())))),C.cursor=C.limit-s,C.ket=C.cursor,r=C.find_among_b(k,6))switch(C.bra=C.cursor,r){case 1:if(c()){if(C.slice_del(),i=C.limit-C.cursor,C.ket=C.cursor,C.eq_s_b(2,"ig")&&(C.bra=C.cursor,c()&&(n=C.limit-C.cursor,!C.eq_s_b(1,"e")))){C.cursor=C.limit-n,C.slice_del();break}C.cursor=C.limit-i,a()}break;case 2:c()&&(o=C.limit-C.cursor,C.eq_s_b(1,"e")||(C.cursor=C.limit-o,C.slice_del()));break;case 3:c()&&(C.slice_del(),l());break;case 4:c()&&C.slice_del();break;case 5:c()&&w&&C.slice_del()}C.cursor=C.limit-s,C.out_grouping_b(z,73,232)&&(t=C.limit-C.cursor,C.find_among_b(v,4)&&C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-t,C.ket=C.cursor,C.cursor>C.limit_backward&&(C.cursor--,C.bra=C.cursor,C.slice_del())))}var d,_,w,b=[new e("",-1,6),new e("á",0,1),new e("ä",0,1),new e("é",0,2),new e("ë",0,2),new e("í",0,3),new e("ï",0,3),new e("ó",0,4),new e("ö",0,4),new e("ú",0,5),new e("ü",0,5)],p=[new e("",-1,3),new e("I",0,2),new e("Y",0,1)],g=[new e("dd",-1,-1),new e("kk",-1,-1),new e("tt",-1,-1)],h=[new e("ene",-1,2),new e("se",-1,3),new e("en",-1,2),new e("heden",2,1),new e("s",-1,3)],k=[new e("end",-1,1),new e("ig",-1,2),new e("ing",-1,1),new e("lijk",-1,3),new e("baar",-1,4),new e("bar",-1,5)],v=[new e("aa",-1,-1),new e("ee",-1,-1),new e("oo",-1,-1),new e("uu",-1,-1)],q=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],z=[1,0,0,17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],j=[17,67,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],C=new i;this.setCurrent=function(r){C.setCurrent(r)},this.getCurrent=function(){return C.getCurrent()},this.stem=function(){var e=C.cursor;return r(),C.cursor=e,o(),C.limit_backward=e,C.cursor=C.limit,f(),C.cursor=C.limit_backward,s(),!0}};return function(r){return"function"==typeof r.update?r.update(function(r){return n.setCurrent(r),n.stem(),n.getCurrent()}):(n.setCurrent(r),n.stem(),n.getCurrent())}}(),r.Pipeline.registerFunction(r.nl.stemmer,"stemmer-nl"),r.nl.stopWordFilter=r.generateStopWordFilter(" aan al alles als altijd andere ben bij daar dan dat de der deze die dit doch doen door dus een eens en er ge geen geweest haar had heb hebben heeft hem het hier hij hoe hun iemand iets ik in is ja je kan kon kunnen maar me meer men met mij mijn moet na naar niet niets nog nu of om omdat onder ons ook op over reeds te tegen toch toen tot u uit uw van veel voor want waren was wat werd wezen wie wil worden wordt zal ze zelf zich zij zijn zo zonder zou".split(" ")),r.Pipeline.registerFunction(r.nl.stopWordFilter,"stopWordFilter-nl")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.no.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.no.min.js new file mode 100644 index 0000000000..92bc7e4e89 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.no.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Norwegian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.no=function(){this.pipeline.reset(),this.pipeline.add(e.no.trimmer,e.no.stopWordFilter,e.no.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.no.stemmer))},e.no.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.no.trimmer=e.trimmerSupport.generateTrimmer(e.no.wordCharacters),e.Pipeline.registerFunction(e.no.trimmer,"trimmer-no"),e.no.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){function e(){var e,r=w.cursor+3;if(a=w.limit,0<=r||r<=w.limit){for(s=r;;){if(e=w.cursor,w.in_grouping(d,97,248)){w.cursor=e;break}if(e>=w.limit)return;w.cursor=e+1}for(;!w.out_grouping(d,97,248);){if(w.cursor>=w.limit)return;w.cursor++}a=w.cursor,a=a&&(r=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,e=w.find_among_b(m,29),w.limit_backward=r,e))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:n=w.limit-w.cursor,w.in_grouping_b(c,98,122)?w.slice_del():(w.cursor=w.limit-n,w.eq_s_b(1,"k")&&w.out_grouping_b(d,97,248)&&w.slice_del());break;case 3:w.slice_from("er")}}function t(){var e,r=w.limit-w.cursor;w.cursor>=a&&(e=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,w.find_among_b(u,2)?(w.bra=w.cursor,w.limit_backward=e,w.cursor=w.limit-r,w.cursor>w.limit_backward&&(w.cursor--,w.bra=w.cursor,w.slice_del())):w.limit_backward=e)}function o(){var e,r;w.cursor>=a&&(r=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,e=w.find_among_b(l,11),e?(w.bra=w.cursor,w.limit_backward=r,1==e&&w.slice_del()):w.limit_backward=r)}var s,a,m=[new r("a",-1,1),new r("e",-1,1),new r("ede",1,1),new r("ande",1,1),new r("ende",1,1),new r("ane",1,1),new r("ene",1,1),new r("hetene",6,1),new r("erte",1,3),new r("en",-1,1),new r("heten",9,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",12,1),new r("s",-1,2),new r("as",14,1),new r("es",14,1),new r("edes",16,1),new r("endes",16,1),new r("enes",16,1),new r("hetenes",19,1),new r("ens",14,1),new r("hetens",21,1),new r("ers",14,1),new r("ets",14,1),new r("et",-1,1),new r("het",25,1),new r("ert",-1,3),new r("ast",-1,1)],u=[new r("dt",-1,-1),new r("vt",-1,-1)],l=[new r("leg",-1,1),new r("eleg",0,1),new r("ig",-1,1),new r("eig",2,1),new r("lig",2,1),new r("elig",4,1),new r("els",-1,1),new r("lov",-1,1),new r("elov",7,1),new r("slov",7,1),new r("hetslov",9,1)],d=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],c=[119,125,149,1],w=new n;this.setCurrent=function(e){w.setCurrent(e)},this.getCurrent=function(){return w.getCurrent()},this.stem=function(){var r=w.cursor;return e(),w.limit_backward=r,w.cursor=w.limit,i(),w.cursor=w.limit,t(),w.cursor=w.limit,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.no.stemmer,"stemmer-no"),e.no.stopWordFilter=e.generateStopWordFilter("alle at av bare begge ble blei bli blir blitt både båe da de deg dei deim deira deires dem den denne der dere deres det dette di din disse ditt du dykk dykkar då eg ein eit eitt eller elles en enn er et ett etter for fordi fra før ha hadde han hans har hennar henne hennes her hjå ho hoe honom hoss hossen hun hva hvem hver hvilke hvilken hvis hvor hvordan hvorfor i ikke ikkje ikkje ingen ingi inkje inn inni ja jeg kan kom korleis korso kun kunne kva kvar kvarhelst kven kvi kvifor man mange me med medan meg meget mellom men mi min mine mitt mot mykje ned no noe noen noka noko nokon nokor nokre nå når og også om opp oss over på samme seg selv si si sia sidan siden sin sine sitt sjøl skal skulle slik so som som somme somt så sånn til um upp ut uten var vart varte ved vere verte vi vil ville vore vors vort vår være være vært å".split(" ")),e.Pipeline.registerFunction(e.no.stopWordFilter,"stopWordFilter-no")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.pt.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.pt.min.js new file mode 100644 index 0000000000..6c16996d65 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.pt.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Portuguese` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.pt=function(){this.pipeline.reset(),this.pipeline.add(e.pt.trimmer,e.pt.stopWordFilter,e.pt.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.pt.stemmer))},e.pt.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.pt.trimmer=e.trimmerSupport.generateTrimmer(e.pt.wordCharacters),e.Pipeline.registerFunction(e.pt.trimmer,"trimmer-pt"),e.pt.stemmer=function(){var r=e.stemmerSupport.Among,s=e.stemmerSupport.SnowballProgram,n=new function(){function e(){for(var e;;){if(z.bra=z.cursor,e=z.find_among(k,3))switch(z.ket=z.cursor,e){case 1:z.slice_from("a~");continue;case 2:z.slice_from("o~");continue;case 3:if(z.cursor>=z.limit)break;z.cursor++;continue}break}}function n(){if(z.out_grouping(y,97,250)){for(;!z.in_grouping(y,97,250);){if(z.cursor>=z.limit)return!0;z.cursor++}return!1}return!0}function i(){if(z.in_grouping(y,97,250))for(;!z.out_grouping(y,97,250);){if(z.cursor>=z.limit)return!1;z.cursor++}return g=z.cursor,!0}function o(){var e,r,s=z.cursor;if(z.in_grouping(y,97,250))if(e=z.cursor,n()){if(z.cursor=e,i())return}else g=z.cursor;if(z.cursor=s,z.out_grouping(y,97,250)){if(r=z.cursor,n()){if(z.cursor=r,!z.in_grouping(y,97,250)||z.cursor>=z.limit)return;z.cursor++}g=z.cursor}}function t(){for(;!z.in_grouping(y,97,250);){if(z.cursor>=z.limit)return!1;z.cursor++}for(;!z.out_grouping(y,97,250);){if(z.cursor>=z.limit)return!1;z.cursor++}return!0}function a(){var e=z.cursor;g=z.limit,b=g,h=g,o(),z.cursor=e,t()&&(b=z.cursor,t()&&(h=z.cursor))}function u(){for(var e;;){if(z.bra=z.cursor,e=z.find_among(q,3))switch(z.ket=z.cursor,e){case 1:z.slice_from("ã");continue;case 2:z.slice_from("õ");continue;case 3:if(z.cursor>=z.limit)break;z.cursor++;continue}break}}function w(){return g<=z.cursor}function m(){return b<=z.cursor}function c(){return h<=z.cursor}function l(){var e;if(z.ket=z.cursor,!(e=z.find_among_b(F,45)))return!1;switch(z.bra=z.cursor,e){case 1:if(!c())return!1;z.slice_del();break;case 2:if(!c())return!1;z.slice_from("log");break;case 3:if(!c())return!1;z.slice_from("u");break;case 4:if(!c())return!1;z.slice_from("ente");break;case 5:if(!m())return!1;z.slice_del(),z.ket=z.cursor,e=z.find_among_b(j,4),e&&(z.bra=z.cursor,c()&&(z.slice_del(),1==e&&(z.ket=z.cursor,z.eq_s_b(2,"at")&&(z.bra=z.cursor,c()&&z.slice_del()))));break;case 6:if(!c())return!1;z.slice_del(),z.ket=z.cursor,e=z.find_among_b(C,3),e&&(z.bra=z.cursor,1==e&&c()&&z.slice_del());break;case 7:if(!c())return!1;z.slice_del(),z.ket=z.cursor,e=z.find_among_b(P,3),e&&(z.bra=z.cursor,1==e&&c()&&z.slice_del());break;case 8:if(!c())return!1;z.slice_del(),z.ket=z.cursor,z.eq_s_b(2,"at")&&(z.bra=z.cursor,c()&&z.slice_del());break;case 9:if(!w()||!z.eq_s_b(1,"e"))return!1;z.slice_from("ir")}return!0}function f(){var e,r;if(z.cursor>=g){if(r=z.limit_backward,z.limit_backward=g,z.ket=z.cursor,e=z.find_among_b(S,120))return z.bra=z.cursor,1==e&&z.slice_del(),z.limit_backward=r,!0;z.limit_backward=r}return!1}function d(){var e;z.ket=z.cursor,(e=z.find_among_b(W,7))&&(z.bra=z.cursor,1==e&&w()&&z.slice_del())}function v(e,r){if(z.eq_s_b(1,e)){z.bra=z.cursor;var s=z.limit-z.cursor;if(z.eq_s_b(1,r))return z.cursor=z.limit-s,w()&&z.slice_del(),!1}return!0}function p(){var e;if(z.ket=z.cursor,e=z.find_among_b(L,4))switch(z.bra=z.cursor,e){case 1:w()&&(z.slice_del(),z.ket=z.cursor,z.limit-z.cursor,v("u","g")&&v("i","c"));break;case 2:z.slice_from("c")}}function _(){if(!l()&&(z.cursor=z.limit,!f()))return z.cursor=z.limit,void d();z.cursor=z.limit,z.ket=z.cursor,z.eq_s_b(1,"i")&&(z.bra=z.cursor,z.eq_s_b(1,"c")&&(z.cursor=z.limit,w()&&z.slice_del()))}var h,b,g,k=[new r("",-1,3),new r("ã",0,1),new r("õ",0,2)],q=[new r("",-1,3),new r("a~",0,1),new r("o~",0,2)],j=[new r("ic",-1,-1),new r("ad",-1,-1),new r("os",-1,-1),new r("iv",-1,1)],C=[new r("ante",-1,1),new r("avel",-1,1),new r("ível",-1,1)],P=[new r("ic",-1,1),new r("abil",-1,1),new r("iv",-1,1)],F=[new r("ica",-1,1),new r("ância",-1,1),new r("ência",-1,4),new r("ira",-1,9),new r("adora",-1,1),new r("osa",-1,1),new r("ista",-1,1),new r("iva",-1,8),new r("eza",-1,1),new r("logía",-1,2),new r("idade",-1,7),new r("ante",-1,1),new r("mente",-1,6),new r("amente",12,5),new r("ável",-1,1),new r("ível",-1,1),new r("ución",-1,3),new r("ico",-1,1),new r("ismo",-1,1),new r("oso",-1,1),new r("amento",-1,1),new r("imento",-1,1),new r("ivo",-1,8),new r("aça~o",-1,1),new r("ador",-1,1),new r("icas",-1,1),new r("ências",-1,4),new r("iras",-1,9),new r("adoras",-1,1),new r("osas",-1,1),new r("istas",-1,1),new r("ivas",-1,8),new r("ezas",-1,1),new r("logías",-1,2),new r("idades",-1,7),new r("uciones",-1,3),new r("adores",-1,1),new r("antes",-1,1),new r("aço~es",-1,1),new r("icos",-1,1),new r("ismos",-1,1),new r("osos",-1,1),new r("amentos",-1,1),new r("imentos",-1,1),new r("ivos",-1,8)],S=[new r("ada",-1,1),new r("ida",-1,1),new r("ia",-1,1),new r("aria",2,1),new r("eria",2,1),new r("iria",2,1),new r("ara",-1,1),new r("era",-1,1),new r("ira",-1,1),new r("ava",-1,1),new r("asse",-1,1),new r("esse",-1,1),new r("isse",-1,1),new r("aste",-1,1),new r("este",-1,1),new r("iste",-1,1),new r("ei",-1,1),new r("arei",16,1),new r("erei",16,1),new r("irei",16,1),new r("am",-1,1),new r("iam",20,1),new r("ariam",21,1),new r("eriam",21,1),new r("iriam",21,1),new r("aram",20,1),new r("eram",20,1),new r("iram",20,1),new r("avam",20,1),new r("em",-1,1),new r("arem",29,1),new r("erem",29,1),new r("irem",29,1),new r("assem",29,1),new r("essem",29,1),new r("issem",29,1),new r("ado",-1,1),new r("ido",-1,1),new r("ando",-1,1),new r("endo",-1,1),new r("indo",-1,1),new r("ara~o",-1,1),new r("era~o",-1,1),new r("ira~o",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("ir",-1,1),new r("as",-1,1),new r("adas",47,1),new r("idas",47,1),new r("ias",47,1),new r("arias",50,1),new r("erias",50,1),new r("irias",50,1),new r("aras",47,1),new r("eras",47,1),new r("iras",47,1),new r("avas",47,1),new r("es",-1,1),new r("ardes",58,1),new r("erdes",58,1),new r("irdes",58,1),new r("ares",58,1),new r("eres",58,1),new r("ires",58,1),new r("asses",58,1),new r("esses",58,1),new r("isses",58,1),new r("astes",58,1),new r("estes",58,1),new r("istes",58,1),new r("is",-1,1),new r("ais",71,1),new r("eis",71,1),new r("areis",73,1),new r("ereis",73,1),new r("ireis",73,1),new r("áreis",73,1),new r("éreis",73,1),new r("íreis",73,1),new r("ásseis",73,1),new r("ésseis",73,1),new r("ísseis",73,1),new r("áveis",73,1),new r("íeis",73,1),new r("aríeis",84,1),new r("eríeis",84,1),new r("iríeis",84,1),new r("ados",-1,1),new r("idos",-1,1),new r("amos",-1,1),new r("áramos",90,1),new r("éramos",90,1),new r("íramos",90,1),new r("ávamos",90,1),new r("íamos",90,1),new r("aríamos",95,1),new r("eríamos",95,1),new r("iríamos",95,1),new r("emos",-1,1),new r("aremos",99,1),new r("eremos",99,1),new r("iremos",99,1),new r("ássemos",99,1),new r("êssemos",99,1),new r("íssemos",99,1),new r("imos",-1,1),new r("armos",-1,1),new r("ermos",-1,1),new r("irmos",-1,1),new r("ámos",-1,1),new r("arás",-1,1),new r("erás",-1,1),new r("irás",-1,1),new r("eu",-1,1),new r("iu",-1,1),new r("ou",-1,1),new r("ará",-1,1),new r("erá",-1,1),new r("irá",-1,1)],W=[new r("a",-1,1),new r("i",-1,1),new r("o",-1,1),new r("os",-1,1),new r("á",-1,1),new r("í",-1,1),new r("ó",-1,1)],L=[new r("e",-1,1),new r("ç",-1,2),new r("é",-1,1),new r("ê",-1,1)],y=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,3,19,12,2],z=new s;this.setCurrent=function(e){z.setCurrent(e)},this.getCurrent=function(){return z.getCurrent()},this.stem=function(){var r=z.cursor;return e(),z.cursor=r,a(),z.limit_backward=r,z.cursor=z.limit,_(),z.cursor=z.limit,p(),z.cursor=z.limit_backward,u(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.pt.stemmer,"stemmer-pt"),e.pt.stopWordFilter=e.generateStopWordFilter("a ao aos aquela aquelas aquele aqueles aquilo as até com como da das de dela delas dele deles depois do dos e ela elas ele eles em entre era eram essa essas esse esses esta estamos estas estava estavam este esteja estejam estejamos estes esteve estive estivemos estiver estivera estiveram estiverem estivermos estivesse estivessem estivéramos estivéssemos estou está estávamos estão eu foi fomos for fora foram forem formos fosse fossem fui fôramos fôssemos haja hajam hajamos havemos hei houve houvemos houver houvera houveram houverei houverem houveremos houveria houveriam houvermos houverá houverão houveríamos houvesse houvessem houvéramos houvéssemos há hão isso isto já lhe lhes mais mas me mesmo meu meus minha minhas muito na nas nem no nos nossa nossas nosso nossos num numa não nós o os ou para pela pelas pelo pelos por qual quando que quem se seja sejam sejamos sem serei seremos seria seriam será serão seríamos seu seus somos sou sua suas são só também te tem temos tenha tenham tenhamos tenho terei teremos teria teriam terá terão teríamos teu teus teve tinha tinham tive tivemos tiver tivera tiveram tiverem tivermos tivesse tivessem tivéramos tivéssemos tu tua tuas tém tínhamos um uma você vocês vos à às éramos".split(" ")),e.Pipeline.registerFunction(e.pt.stopWordFilter,"stopWordFilter-pt")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.ro.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.ro.min.js new file mode 100644 index 0000000000..7277140181 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.ro.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Romanian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,i){"function"==typeof define&&define.amd?define(i):"object"==typeof exports?module.exports=i():i()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.ro=function(){this.pipeline.reset(),this.pipeline.add(e.ro.trimmer,e.ro.stopWordFilter,e.ro.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.ro.stemmer))},e.ro.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.ro.trimmer=e.trimmerSupport.generateTrimmer(e.ro.wordCharacters),e.Pipeline.registerFunction(e.ro.trimmer,"trimmer-ro"),e.ro.stemmer=function(){var i=e.stemmerSupport.Among,r=e.stemmerSupport.SnowballProgram,n=new function(){function e(e,i){L.eq_s(1,e)&&(L.ket=L.cursor,L.in_grouping(W,97,259)&&L.slice_from(i))}function n(){for(var i,r;;){if(i=L.cursor,L.in_grouping(W,97,259)&&(r=L.cursor,L.bra=r,e("u","U"),L.cursor=r,e("i","I")),L.cursor=i,L.cursor>=L.limit)break;L.cursor++}}function t(){if(L.out_grouping(W,97,259)){for(;!L.in_grouping(W,97,259);){if(L.cursor>=L.limit)return!0;L.cursor++}return!1}return!0}function a(){if(L.in_grouping(W,97,259))for(;!L.out_grouping(W,97,259);){if(L.cursor>=L.limit)return!0;L.cursor++}return!1}function o(){var e,i,r=L.cursor;if(L.in_grouping(W,97,259)){if(e=L.cursor,!t())return void(h=L.cursor);if(L.cursor=e,!a())return void(h=L.cursor)}L.cursor=r,L.out_grouping(W,97,259)&&(i=L.cursor,t()&&(L.cursor=i,L.in_grouping(W,97,259)&&L.cursor=L.limit)return!1;L.cursor++}for(;!L.out_grouping(W,97,259);){if(L.cursor>=L.limit)return!1;L.cursor++}return!0}function c(){var e=L.cursor;h=L.limit,k=h,g=h,o(),L.cursor=e,u()&&(k=L.cursor,u()&&(g=L.cursor))}function s(){for(var e;;){if(L.bra=L.cursor,e=L.find_among(z,3))switch(L.ket=L.cursor,e){case 1:L.slice_from("i");continue;case 2:L.slice_from("u");continue;case 3:if(L.cursor>=L.limit)break;L.cursor++;continue}break}}function w(){return h<=L.cursor}function m(){return k<=L.cursor}function l(){return g<=L.cursor}function f(){var e,i;if(L.ket=L.cursor,(e=L.find_among_b(C,16))&&(L.bra=L.cursor,m()))switch(e){case 1:L.slice_del();break;case 2:L.slice_from("a");break;case 3:L.slice_from("e");break;case 4:L.slice_from("i");break;case 5:i=L.limit-L.cursor,L.eq_s_b(2,"ab")||(L.cursor=L.limit-i,L.slice_from("i"));break;case 6:L.slice_from("at");break;case 7:L.slice_from("aţi")}}function p(){var e,i=L.limit-L.cursor;if(L.ket=L.cursor,(e=L.find_among_b(P,46))&&(L.bra=L.cursor,m())){switch(e){case 1:L.slice_from("abil");break;case 2:L.slice_from("ibil");break;case 3:L.slice_from("iv");break;case 4:L.slice_from("ic");break;case 5:L.slice_from("at");break;case 6:L.slice_from("it")}return _=!0,L.cursor=L.limit-i,!0}return!1}function d(){var e,i;for(_=!1;;)if(i=L.limit-L.cursor,!p()){L.cursor=L.limit-i;break}if(L.ket=L.cursor,(e=L.find_among_b(F,62))&&(L.bra=L.cursor,l())){switch(e){case 1:L.slice_del();break;case 2:L.eq_s_b(1,"ţ")&&(L.bra=L.cursor,L.slice_from("t"));break;case 3:L.slice_from("ist")}_=!0}}function b(){var e,i,r;if(L.cursor>=h){if(i=L.limit_backward,L.limit_backward=h,L.ket=L.cursor,e=L.find_among_b(q,94))switch(L.bra=L.cursor,e){case 1:if(r=L.limit-L.cursor,!L.out_grouping_b(W,97,259)&&(L.cursor=L.limit-r,!L.eq_s_b(1,"u")))break;case 2:L.slice_del()}L.limit_backward=i}}function v(){var e;L.ket=L.cursor,(e=L.find_among_b(S,5))&&(L.bra=L.cursor,w()&&1==e&&L.slice_del())}var _,g,k,h,z=[new i("",-1,3),new i("I",0,1),new i("U",0,2)],C=[new i("ea",-1,3),new i("aţia",-1,7),new i("aua",-1,2),new i("iua",-1,4),new i("aţie",-1,7),new i("ele",-1,3),new i("ile",-1,5),new i("iile",6,4),new i("iei",-1,4),new i("atei",-1,6),new i("ii",-1,4),new i("ului",-1,1),new i("ul",-1,1),new i("elor",-1,3),new i("ilor",-1,4),new i("iilor",14,4)],P=[new i("icala",-1,4),new i("iciva",-1,4),new i("ativa",-1,5),new i("itiva",-1,6),new i("icale",-1,4),new i("aţiune",-1,5),new i("iţiune",-1,6),new i("atoare",-1,5),new i("itoare",-1,6),new i("ătoare",-1,5),new i("icitate",-1,4),new i("abilitate",-1,1),new i("ibilitate",-1,2),new i("ivitate",-1,3),new i("icive",-1,4),new i("ative",-1,5),new i("itive",-1,6),new i("icali",-1,4),new i("atori",-1,5),new i("icatori",18,4),new i("itori",-1,6),new i("ători",-1,5),new i("icitati",-1,4),new i("abilitati",-1,1),new i("ivitati",-1,3),new i("icivi",-1,4),new i("ativi",-1,5),new i("itivi",-1,6),new i("icităi",-1,4),new i("abilităi",-1,1),new i("ivităi",-1,3),new i("icităţi",-1,4),new i("abilităţi",-1,1),new i("ivităţi",-1,3),new i("ical",-1,4),new i("ator",-1,5),new i("icator",35,4),new i("itor",-1,6),new i("ător",-1,5),new i("iciv",-1,4),new i("ativ",-1,5),new i("itiv",-1,6),new i("icală",-1,4),new i("icivă",-1,4),new i("ativă",-1,5),new i("itivă",-1,6)],F=[new i("ica",-1,1),new i("abila",-1,1),new i("ibila",-1,1),new i("oasa",-1,1),new i("ata",-1,1),new i("ita",-1,1),new i("anta",-1,1),new i("ista",-1,3),new i("uta",-1,1),new i("iva",-1,1),new i("ic",-1,1),new i("ice",-1,1),new i("abile",-1,1),new i("ibile",-1,1),new i("isme",-1,3),new i("iune",-1,2),new i("oase",-1,1),new i("ate",-1,1),new i("itate",17,1),new i("ite",-1,1),new i("ante",-1,1),new i("iste",-1,3),new i("ute",-1,1),new i("ive",-1,1),new i("ici",-1,1),new i("abili",-1,1),new i("ibili",-1,1),new i("iuni",-1,2),new i("atori",-1,1),new i("osi",-1,1),new i("ati",-1,1),new i("itati",30,1),new i("iti",-1,1),new i("anti",-1,1),new i("isti",-1,3),new i("uti",-1,1),new i("işti",-1,3),new i("ivi",-1,1),new i("ităi",-1,1),new i("oşi",-1,1),new i("ităţi",-1,1),new i("abil",-1,1),new i("ibil",-1,1),new i("ism",-1,3),new i("ator",-1,1),new i("os",-1,1),new i("at",-1,1),new i("it",-1,1),new i("ant",-1,1),new i("ist",-1,3),new i("ut",-1,1),new i("iv",-1,1),new i("ică",-1,1),new i("abilă",-1,1),new i("ibilă",-1,1),new i("oasă",-1,1),new i("ată",-1,1),new i("ită",-1,1),new i("antă",-1,1),new i("istă",-1,3),new i("ută",-1,1),new i("ivă",-1,1)],q=[new i("ea",-1,1),new i("ia",-1,1),new i("esc",-1,1),new i("ăsc",-1,1),new i("ind",-1,1),new i("ând",-1,1),new i("are",-1,1),new i("ere",-1,1),new i("ire",-1,1),new i("âre",-1,1),new i("se",-1,2),new i("ase",10,1),new i("sese",10,2),new i("ise",10,1),new i("use",10,1),new i("âse",10,1),new i("eşte",-1,1),new i("ăşte",-1,1),new i("eze",-1,1),new i("ai",-1,1),new i("eai",19,1),new i("iai",19,1),new i("sei",-1,2),new i("eşti",-1,1),new i("ăşti",-1,1),new i("ui",-1,1),new i("ezi",-1,1),new i("âi",-1,1),new i("aşi",-1,1),new i("seşi",-1,2),new i("aseşi",29,1),new i("seseşi",29,2),new i("iseşi",29,1),new i("useşi",29,1),new i("âseşi",29,1),new i("işi",-1,1),new i("uşi",-1,1),new i("âşi",-1,1),new i("aţi",-1,2),new i("eaţi",38,1),new i("iaţi",38,1),new i("eţi",-1,2),new i("iţi",-1,2),new i("âţi",-1,2),new i("arăţi",-1,1),new i("serăţi",-1,2),new i("aserăţi",45,1),new i("seserăţi",45,2),new i("iserăţi",45,1),new i("userăţi",45,1),new i("âserăţi",45,1),new i("irăţi",-1,1),new i("urăţi",-1,1),new i("ârăţi",-1,1),new i("am",-1,1),new i("eam",54,1),new i("iam",54,1),new i("em",-1,2),new i("asem",57,1),new i("sesem",57,2),new i("isem",57,1),new i("usem",57,1),new i("âsem",57,1),new i("im",-1,2),new i("âm",-1,2),new i("ăm",-1,2),new i("arăm",65,1),new i("serăm",65,2),new i("aserăm",67,1),new i("seserăm",67,2),new i("iserăm",67,1),new i("userăm",67,1),new i("âserăm",67,1),new i("irăm",65,1),new i("urăm",65,1),new i("ârăm",65,1),new i("au",-1,1),new i("eau",76,1),new i("iau",76,1),new i("indu",-1,1),new i("ându",-1,1),new i("ez",-1,1),new i("ească",-1,1),new i("ară",-1,1),new i("seră",-1,2),new i("aseră",84,1),new i("seseră",84,2),new i("iseră",84,1),new i("useră",84,1),new i("âseră",84,1),new i("iră",-1,1),new i("ură",-1,1),new i("âră",-1,1),new i("ează",-1,1)],S=[new i("a",-1,1),new i("e",-1,1),new i("ie",1,1),new i("i",-1,1),new i("ă",-1,1)],W=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,2,32,0,0,4],L=new r;this.setCurrent=function(e){L.setCurrent(e)},this.getCurrent=function(){return L.getCurrent()},this.stem=function(){var e=L.cursor;return n(),L.cursor=e,c(),L.limit_backward=e,L.cursor=L.limit,f(),L.cursor=L.limit,d(),L.cursor=L.limit,_||(L.cursor=L.limit,b(),L.cursor=L.limit),v(),L.cursor=L.limit_backward,s(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.ro.stemmer,"stemmer-ro"),e.ro.stopWordFilter=e.generateStopWordFilter("acea aceasta această aceea acei aceia acel acela acele acelea acest acesta aceste acestea aceşti aceştia acolo acord acum ai aia aibă aici al ale alea altceva altcineva am ar are asemenea asta astea astăzi asupra au avea avem aveţi azi aş aşadar aţi bine bucur bună ca care caut ce cel ceva chiar cinci cine cineva contra cu cum cumva curând curînd când cât câte câtva câţi cînd cît cîte cîtva cîţi că căci cărei căror cărui către da dacă dar datorită dată dau de deci deja deoarece departe deşi din dinaintea dintr- dintre doi doilea două drept după dă ea ei el ele eram este eu eşti face fata fi fie fiecare fii fim fiu fiţi frumos fără graţie halbă iar ieri la le li lor lui lângă lîngă mai mea mei mele mereu meu mi mie mine mult multă mulţi mulţumesc mâine mîine mă ne nevoie nici nicăieri nimeni nimeri nimic nişte noastre noastră noi noroc nostru nouă noştri nu opt ori oricare orice oricine oricum oricând oricât oricînd oricît oriunde patra patru patrulea pe pentru peste pic poate pot prea prima primul prin puţin puţina puţină până pînă rog sa sale sau se spate spre sub sunt suntem sunteţi sută sînt sîntem sînteţi să săi său ta tale te timp tine toate toată tot totuşi toţi trei treia treilea tu tăi tău un una unde undeva unei uneia unele uneori unii unor unora unu unui unuia unul vi voastre voastră voi vostru vouă voştri vreme vreo vreun vă zece zero zi zice îi îl îmi împotriva în înainte înaintea încotro încât încît între întrucât întrucît îţi ăla ălea ăsta ăstea ăştia şapte şase şi ştiu ţi ţie".split(" ")),e.Pipeline.registerFunction(e.ro.stopWordFilter,"stopWordFilter-ro")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.ru.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.ru.min.js new file mode 100644 index 0000000000..186cc485c2 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.ru.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Russian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,n){"function"==typeof define&&define.amd?define(n):"object"==typeof exports?module.exports=n():n()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.ru=function(){this.pipeline.reset(),this.pipeline.add(e.ru.trimmer,e.ru.stopWordFilter,e.ru.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.ru.stemmer))},e.ru.wordCharacters="Ѐ-҄҇-ԯᴫᵸⷠ-ⷿꙀ-ꚟ︮︯",e.ru.trimmer=e.trimmerSupport.generateTrimmer(e.ru.wordCharacters),e.Pipeline.registerFunction(e.ru.trimmer,"trimmer-ru"),e.ru.stemmer=function(){var n=e.stemmerSupport.Among,r=e.stemmerSupport.SnowballProgram,t=new function(){function e(){for(;!W.in_grouping(S,1072,1103);){if(W.cursor>=W.limit)return!1;W.cursor++}return!0}function t(){for(;!W.out_grouping(S,1072,1103);){if(W.cursor>=W.limit)return!1;W.cursor++}return!0}function w(){b=W.limit,_=b,e()&&(b=W.cursor,t()&&e()&&t()&&(_=W.cursor))}function i(){return _<=W.cursor}function u(e,n){var r,t;if(W.ket=W.cursor,r=W.find_among_b(e,n)){switch(W.bra=W.cursor,r){case 1:if(t=W.limit-W.cursor,!W.eq_s_b(1,"а")&&(W.cursor=W.limit-t,!W.eq_s_b(1,"я")))return!1;case 2:W.slice_del()}return!0}return!1}function o(){return u(h,9)}function s(e,n){var r;return W.ket=W.cursor,!!(r=W.find_among_b(e,n))&&(W.bra=W.cursor,1==r&&W.slice_del(),!0)}function c(){return s(g,26)}function m(){return!!c()&&(u(C,8),!0)}function f(){return s(k,2)}function l(){return u(P,46)}function a(){s(v,36)}function p(){var e;W.ket=W.cursor,(e=W.find_among_b(F,2))&&(W.bra=W.cursor,i()&&1==e&&W.slice_del())}function d(){var e;if(W.ket=W.cursor,e=W.find_among_b(q,4))switch(W.bra=W.cursor,e){case 1:if(W.slice_del(),W.ket=W.cursor,!W.eq_s_b(1,"н"))break;W.bra=W.cursor;case 2:if(!W.eq_s_b(1,"н"))break;case 3:W.slice_del()}}var _,b,h=[new n("в",-1,1),new n("ив",0,2),new n("ыв",0,2),new n("вши",-1,1),new n("ивши",3,2),new n("ывши",3,2),new n("вшись",-1,1),new n("ившись",6,2),new n("ывшись",6,2)],g=[new n("ее",-1,1),new n("ие",-1,1),new n("ое",-1,1),new n("ые",-1,1),new n("ими",-1,1),new n("ыми",-1,1),new n("ей",-1,1),new n("ий",-1,1),new n("ой",-1,1),new n("ый",-1,1),new n("ем",-1,1),new n("им",-1,1),new n("ом",-1,1),new n("ым",-1,1),new n("его",-1,1),new n("ого",-1,1),new n("ему",-1,1),new n("ому",-1,1),new n("их",-1,1),new n("ых",-1,1),new n("ею",-1,1),new n("ою",-1,1),new n("ую",-1,1),new n("юю",-1,1),new n("ая",-1,1),new n("яя",-1,1)],C=[new n("ем",-1,1),new n("нн",-1,1),new n("вш",-1,1),new n("ивш",2,2),new n("ывш",2,2),new n("щ",-1,1),new n("ющ",5,1),new n("ующ",6,2)],k=[new n("сь",-1,1),new n("ся",-1,1)],P=[new n("ла",-1,1),new n("ила",0,2),new n("ыла",0,2),new n("на",-1,1),new n("ена",3,2),new n("ете",-1,1),new n("ите",-1,2),new n("йте",-1,1),new n("ейте",7,2),new n("уйте",7,2),new n("ли",-1,1),new n("или",10,2),new n("ыли",10,2),new n("й",-1,1),new n("ей",13,2),new n("уй",13,2),new n("л",-1,1),new n("ил",16,2),new n("ыл",16,2),new n("ем",-1,1),new n("им",-1,2),new n("ым",-1,2),new n("н",-1,1),new n("ен",22,2),new n("ло",-1,1),new n("ило",24,2),new n("ыло",24,2),new n("но",-1,1),new n("ено",27,2),new n("нно",27,1),new n("ет",-1,1),new n("ует",30,2),new n("ит",-1,2),new n("ыт",-1,2),new n("ют",-1,1),new n("уют",34,2),new n("ят",-1,2),new n("ны",-1,1),new n("ены",37,2),new n("ть",-1,1),new n("ить",39,2),new n("ыть",39,2),new n("ешь",-1,1),new n("ишь",-1,2),new n("ю",-1,2),new n("ую",44,2)],v=[new n("а",-1,1),new n("ев",-1,1),new n("ов",-1,1),new n("е",-1,1),new n("ие",3,1),new n("ье",3,1),new n("и",-1,1),new n("еи",6,1),new n("ии",6,1),new n("ами",6,1),new n("ями",6,1),new n("иями",10,1),new n("й",-1,1),new n("ей",12,1),new n("ией",13,1),new n("ий",12,1),new n("ой",12,1),new n("ам",-1,1),new n("ем",-1,1),new n("ием",18,1),new n("ом",-1,1),new n("ям",-1,1),new n("иям",21,1),new n("о",-1,1),new n("у",-1,1),new n("ах",-1,1),new n("ях",-1,1),new n("иях",26,1),new n("ы",-1,1),new n("ь",-1,1),new n("ю",-1,1),new n("ию",30,1),new n("ью",30,1),new n("я",-1,1),new n("ия",33,1),new n("ья",33,1)],F=[new n("ост",-1,1),new n("ость",-1,1)],q=[new n("ейше",-1,1),new n("н",-1,2),new n("ейш",-1,1),new n("ь",-1,3)],S=[33,65,8,232],W=new r;this.setCurrent=function(e){W.setCurrent(e)},this.getCurrent=function(){return W.getCurrent()},this.stem=function(){return w(),W.cursor=W.limit,!(W.cursor=i&&(e-=i,t[e>>3]&1<<(7&e)))return this.cursor++,!0}return!1},in_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e<=s&&e>=i&&(e-=i,t[e>>3]&1<<(7&e)))return this.cursor--,!0}return!1},out_grouping:function(t,i,s){if(this.cursors||e>3]&1<<(7&e)))return this.cursor++,!0}return!1},out_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e>s||e>3]&1<<(7&e)))return this.cursor--,!0}return!1},eq_s:function(t,i){if(this.limit-this.cursor>1),f=0,l=o0||e==s||c)break;c=!0}}for(;;){var _=t[s];if(o>=_.s_size){if(this.cursor=n+_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n+_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},find_among_b:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit_backward,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o=0;m--){if(n-l==u){f=-1;break}if(f=r.charCodeAt(n-1-l)-_.s[m])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){var _=t[s];if(o>=_.s_size){if(this.cursor=n-_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n-_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},replace_s:function(t,i,s){var e=s.length-(i-t),n=r.substring(0,t),u=r.substring(i);return r=n+s+u,this.limit+=e,this.cursor>=i?this.cursor+=e:this.cursor>t&&(this.cursor=t),e},slice_check:function(){if(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>r.length)throw"faulty slice operation"},slice_from:function(r){this.slice_check(),this.replace_s(this.bra,this.ket,r)},slice_del:function(){this.slice_from("")},insert:function(r,t,i){var s=this.replace_s(r,t,i);r<=this.bra&&(this.bra+=s),r<=this.ket&&(this.ket+=s)},slice_to:function(){return this.slice_check(),r.substring(this.bra,this.ket)},eq_v_b:function(r){return this.eq_s_b(r.length,r)}}}},r.trimmerSupport={generateTrimmer:function(r){var t=new RegExp("^[^"+r+"]+"),i=new RegExp("[^"+r+"]+$");return function(r){return"function"==typeof r.update?r.update(function(r){return r.replace(t,"").replace(i,"")}):r.replace(t,"").replace(i,"")}}}}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.sv.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.sv.min.js new file mode 100644 index 0000000000..3e5eb64000 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.sv.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Swedish` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.sv=function(){this.pipeline.reset(),this.pipeline.add(e.sv.trimmer,e.sv.stopWordFilter,e.sv.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sv.stemmer))},e.sv.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.sv.trimmer=e.trimmerSupport.generateTrimmer(e.sv.wordCharacters),e.Pipeline.registerFunction(e.sv.trimmer,"trimmer-sv"),e.sv.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,t=new function(){function e(){var e,r=w.cursor+3;if(o=w.limit,0<=r||r<=w.limit){for(a=r;;){if(e=w.cursor,w.in_grouping(l,97,246)){w.cursor=e;break}if(w.cursor=e,w.cursor>=w.limit)return;w.cursor++}for(;!w.out_grouping(l,97,246);){if(w.cursor>=w.limit)return;w.cursor++}o=w.cursor,o=o&&(w.limit_backward=o,w.cursor=w.limit,w.ket=w.cursor,e=w.find_among_b(u,37),w.limit_backward=r,e))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:w.in_grouping_b(d,98,121)&&w.slice_del()}}function i(){var e=w.limit_backward;w.cursor>=o&&(w.limit_backward=o,w.cursor=w.limit,w.find_among_b(c,7)&&(w.cursor=w.limit,w.ket=w.cursor,w.cursor>w.limit_backward&&(w.bra=--w.cursor,w.slice_del())),w.limit_backward=e)}function s(){var e,r;if(w.cursor>=o){if(r=w.limit_backward,w.limit_backward=o,w.cursor=w.limit,w.ket=w.cursor,e=w.find_among_b(m,5))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:w.slice_from("lös");break;case 3:w.slice_from("full")}w.limit_backward=r}}var a,o,u=[new r("a",-1,1),new r("arna",0,1),new r("erna",0,1),new r("heterna",2,1),new r("orna",0,1),new r("ad",-1,1),new r("e",-1,1),new r("ade",6,1),new r("ande",6,1),new r("arne",6,1),new r("are",6,1),new r("aste",6,1),new r("en",-1,1),new r("anden",12,1),new r("aren",12,1),new r("heten",12,1),new r("ern",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",18,1),new r("or",-1,1),new r("s",-1,2),new r("as",21,1),new r("arnas",22,1),new r("ernas",22,1),new r("ornas",22,1),new r("es",21,1),new r("ades",26,1),new r("andes",26,1),new r("ens",21,1),new r("arens",29,1),new r("hetens",29,1),new r("erns",21,1),new r("at",-1,1),new r("andet",-1,1),new r("het",-1,1),new r("ast",-1,1)],c=[new r("dd",-1,-1),new r("gd",-1,-1),new r("nn",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1),new r("tt",-1,-1)],m=[new r("ig",-1,1),new r("lig",0,1),new r("els",-1,1),new r("fullt",-1,3),new r("löst",-1,2)],l=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,24,0,32],d=[119,127,149],w=new n;this.setCurrent=function(e){w.setCurrent(e)},this.getCurrent=function(){return w.getCurrent()},this.stem=function(){var r=w.cursor;return e(),w.limit_backward=r,w.cursor=w.limit,t(),w.cursor=w.limit,i(),w.cursor=w.limit,s(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return t.setCurrent(e),t.stem(),t.getCurrent()}):(t.setCurrent(e),t.stem(),t.getCurrent())}}(),e.Pipeline.registerFunction(e.sv.stemmer,"stemmer-sv"),e.sv.stopWordFilter=e.generateStopWordFilter("alla allt att av blev bli blir blivit de dem den denna deras dess dessa det detta dig din dina ditt du där då efter ej eller en er era ert ett från för ha hade han hans har henne hennes hon honom hur här i icke ingen inom inte jag ju kan kunde man med mellan men mig min mina mitt mot mycket ni nu när någon något några och om oss på samma sedan sig sin sina sitta själv skulle som så sådan sådana sådant till under upp ut utan vad var vara varför varit varje vars vart vem vi vid vilka vilkas vilken vilket vår våra vårt än är åt över".split(" ")),e.Pipeline.registerFunction(e.sv.stopWordFilter,"stopWordFilter-sv")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.tr.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.tr.min.js new file mode 100644 index 0000000000..563f6ec1f5 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.tr.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Turkish` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(r,i){"function"==typeof define&&define.amd?define(i):"object"==typeof exports?module.exports=i():i()(r.lunr)}(this,function(){return function(r){if(void 0===r)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===r.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");r.tr=function(){this.pipeline.reset(),this.pipeline.add(r.tr.trimmer,r.tr.stopWordFilter,r.tr.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(r.tr.stemmer))},r.tr.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",r.tr.trimmer=r.trimmerSupport.generateTrimmer(r.tr.wordCharacters),r.Pipeline.registerFunction(r.tr.trimmer,"trimmer-tr"),r.tr.stemmer=function(){var i=r.stemmerSupport.Among,e=r.stemmerSupport.SnowballProgram,n=new function(){function r(r,i,e){for(;;){var n=Dr.limit-Dr.cursor;if(Dr.in_grouping_b(r,i,e)){Dr.cursor=Dr.limit-n;break}if(Dr.cursor=Dr.limit-n,Dr.cursor<=Dr.limit_backward)return!1;Dr.cursor--}return!0}function n(){var i,e;i=Dr.limit-Dr.cursor,r(Wr,97,305);for(var n=0;nDr.limit_backward&&(Dr.cursor--,e=Dr.limit-Dr.cursor,i()))?(Dr.cursor=Dr.limit-e,!0):(Dr.cursor=Dr.limit-n,r()?(Dr.cursor=Dr.limit-n,!1):(Dr.cursor=Dr.limit-n,!(Dr.cursor<=Dr.limit_backward)&&(Dr.cursor--,!!i()&&(Dr.cursor=Dr.limit-n,!0))))}function u(r){return t(r,function(){return Dr.in_grouping_b(Wr,97,305)})}function o(){return u(function(){return Dr.eq_s_b(1,"n")})}function s(){return u(function(){return Dr.eq_s_b(1,"s")})}function c(){return u(function(){return Dr.eq_s_b(1,"y")})}function l(){return t(function(){return Dr.in_grouping_b(Lr,105,305)},function(){return Dr.out_grouping_b(Wr,97,305)})}function a(){return Dr.find_among_b(ur,10)&&l()}function m(){return n()&&Dr.in_grouping_b(Lr,105,305)&&s()}function d(){return Dr.find_among_b(or,2)}function f(){return n()&&Dr.in_grouping_b(Lr,105,305)&&c()}function b(){return n()&&Dr.find_among_b(sr,4)}function w(){return n()&&Dr.find_among_b(cr,4)&&o()}function _(){return n()&&Dr.find_among_b(lr,2)&&c()}function k(){return n()&&Dr.find_among_b(ar,2)}function p(){return n()&&Dr.find_among_b(mr,4)}function g(){return n()&&Dr.find_among_b(dr,2)}function y(){return n()&&Dr.find_among_b(fr,4)}function z(){return n()&&Dr.find_among_b(br,2)}function v(){return n()&&Dr.find_among_b(wr,2)&&c()}function h(){return Dr.eq_s_b(2,"ki")}function q(){return n()&&Dr.find_among_b(_r,2)&&o()}function C(){return n()&&Dr.find_among_b(kr,4)&&c()}function P(){return n()&&Dr.find_among_b(pr,4)}function F(){return n()&&Dr.find_among_b(gr,4)&&c()}function S(){return Dr.find_among_b(yr,4)}function W(){return n()&&Dr.find_among_b(zr,2)}function L(){return n()&&Dr.find_among_b(vr,4)}function x(){return n()&&Dr.find_among_b(hr,8)}function A(){return Dr.find_among_b(qr,2)}function E(){return n()&&Dr.find_among_b(Cr,32)&&c()}function j(){return Dr.find_among_b(Pr,8)&&c()}function T(){return n()&&Dr.find_among_b(Fr,4)&&c()}function Z(){return Dr.eq_s_b(3,"ken")&&c()}function B(){var r=Dr.limit-Dr.cursor;return!(T()||(Dr.cursor=Dr.limit-r,E()||(Dr.cursor=Dr.limit-r,j()||(Dr.cursor=Dr.limit-r,Z()))))}function D(){if(A()){var r=Dr.limit-Dr.cursor;if(S()||(Dr.cursor=Dr.limit-r,W()||(Dr.cursor=Dr.limit-r,C()||(Dr.cursor=Dr.limit-r,P()||(Dr.cursor=Dr.limit-r,F()||(Dr.cursor=Dr.limit-r))))),T())return!1}return!0}function G(){if(W()){Dr.bra=Dr.cursor,Dr.slice_del();var r=Dr.limit-Dr.cursor;return Dr.ket=Dr.cursor,x()||(Dr.cursor=Dr.limit-r,E()||(Dr.cursor=Dr.limit-r,j()||(Dr.cursor=Dr.limit-r,T()||(Dr.cursor=Dr.limit-r)))),nr=!1,!1}return!0}function H(){if(!L())return!0;var r=Dr.limit-Dr.cursor;return!E()&&(Dr.cursor=Dr.limit-r,!j())}function I(){var r,i=Dr.limit-Dr.cursor;return!(S()||(Dr.cursor=Dr.limit-i,F()||(Dr.cursor=Dr.limit-i,P()||(Dr.cursor=Dr.limit-i,C()))))||(Dr.bra=Dr.cursor,Dr.slice_del(),r=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,T()||(Dr.cursor=Dr.limit-r),!1)}function J(){var r,i=Dr.limit-Dr.cursor;if(Dr.ket=Dr.cursor,nr=!0,B()&&(Dr.cursor=Dr.limit-i,D()&&(Dr.cursor=Dr.limit-i,G()&&(Dr.cursor=Dr.limit-i,H()&&(Dr.cursor=Dr.limit-i,I()))))){if(Dr.cursor=Dr.limit-i,!x())return;Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,r=Dr.limit-Dr.cursor,S()||(Dr.cursor=Dr.limit-r,W()||(Dr.cursor=Dr.limit-r,C()||(Dr.cursor=Dr.limit-r,P()||(Dr.cursor=Dr.limit-r,F()||(Dr.cursor=Dr.limit-r))))),T()||(Dr.cursor=Dr.limit-r)}Dr.bra=Dr.cursor,Dr.slice_del()}function K(){var r,i,e,n;if(Dr.ket=Dr.cursor,h()){if(r=Dr.limit-Dr.cursor,p())return Dr.bra=Dr.cursor,Dr.slice_del(),i=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,W()?(Dr.bra=Dr.cursor,Dr.slice_del(),K()):(Dr.cursor=Dr.limit-i,a()&&(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K()))),!0;if(Dr.cursor=Dr.limit-r,w()){if(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,e=Dr.limit-Dr.cursor,d())Dr.bra=Dr.cursor,Dr.slice_del();else{if(Dr.cursor=Dr.limit-e,Dr.ket=Dr.cursor,!a()&&(Dr.cursor=Dr.limit-e,!m()&&(Dr.cursor=Dr.limit-e,!K())))return!0;Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K())}return!0}if(Dr.cursor=Dr.limit-r,g()){if(n=Dr.limit-Dr.cursor,d())Dr.bra=Dr.cursor,Dr.slice_del();else if(Dr.cursor=Dr.limit-n,m())Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K());else if(Dr.cursor=Dr.limit-n,!K())return!1;return!0}}return!1}function M(r){if(Dr.ket=Dr.cursor,!g()&&(Dr.cursor=Dr.limit-r,!k()))return!1;var i=Dr.limit-Dr.cursor;if(d())Dr.bra=Dr.cursor,Dr.slice_del();else if(Dr.cursor=Dr.limit-i,m())Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K());else if(Dr.cursor=Dr.limit-i,!K())return!1;return!0}function N(r){if(Dr.ket=Dr.cursor,!z()&&(Dr.cursor=Dr.limit-r,!b()))return!1;var i=Dr.limit-Dr.cursor;return!(!m()&&(Dr.cursor=Dr.limit-i,!d()))&&(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K()),!0)}function O(){var r,i=Dr.limit-Dr.cursor;return Dr.ket=Dr.cursor,!(!w()&&(Dr.cursor=Dr.limit-i,!v()))&&(Dr.bra=Dr.cursor,Dr.slice_del(),r=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,!(!W()||(Dr.bra=Dr.cursor,Dr.slice_del(),!K()))||(Dr.cursor=Dr.limit-r,Dr.ket=Dr.cursor,!(a()||(Dr.cursor=Dr.limit-r,m()||(Dr.cursor=Dr.limit-r,K())))||(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K()),!0)))}function Q(){var r,i,e=Dr.limit-Dr.cursor;if(Dr.ket=Dr.cursor,!p()&&(Dr.cursor=Dr.limit-e,!f()&&(Dr.cursor=Dr.limit-e,!_())))return!1;if(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,r=Dr.limit-Dr.cursor,a())Dr.bra=Dr.cursor,Dr.slice_del(),i=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,W()||(Dr.cursor=Dr.limit-i);else if(Dr.cursor=Dr.limit-r,!W())return!0;return Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,K(),!0}function R(){var r,i,e=Dr.limit-Dr.cursor;if(Dr.ket=Dr.cursor,W())return Dr.bra=Dr.cursor,Dr.slice_del(),void K();if(Dr.cursor=Dr.limit-e,Dr.ket=Dr.cursor,q())if(Dr.bra=Dr.cursor,Dr.slice_del(),r=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,d())Dr.bra=Dr.cursor,Dr.slice_del();else{if(Dr.cursor=Dr.limit-r,Dr.ket=Dr.cursor,!a()&&(Dr.cursor=Dr.limit-r,!m())){if(Dr.cursor=Dr.limit-r,Dr.ket=Dr.cursor,!W())return;if(Dr.bra=Dr.cursor,Dr.slice_del(),!K())return}Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K())}else if(Dr.cursor=Dr.limit-e,!M(e)&&(Dr.cursor=Dr.limit-e,!N(e))){if(Dr.cursor=Dr.limit-e,Dr.ket=Dr.cursor,y())return Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,i=Dr.limit-Dr.cursor,void(a()?(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K())):(Dr.cursor=Dr.limit-i,W()?(Dr.bra=Dr.cursor,Dr.slice_del(),K()):(Dr.cursor=Dr.limit-i,K())));if(Dr.cursor=Dr.limit-e,!O()){if(Dr.cursor=Dr.limit-e,d())return Dr.bra=Dr.cursor,void Dr.slice_del();Dr.cursor=Dr.limit-e,K()||(Dr.cursor=Dr.limit-e,Q()||(Dr.cursor=Dr.limit-e,Dr.ket=Dr.cursor,(a()||(Dr.cursor=Dr.limit-e,m()))&&(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K()))))}}}function U(){var r;if(Dr.ket=Dr.cursor,r=Dr.find_among_b(Sr,4))switch(Dr.bra=Dr.cursor,r){case 1:Dr.slice_from("p");break;case 2:Dr.slice_from("ç");break;case 3:Dr.slice_from("t");break;case 4:Dr.slice_from("k")}}function V(){for(;;){var r=Dr.limit-Dr.cursor;if(Dr.in_grouping_b(Wr,97,305)){Dr.cursor=Dr.limit-r;break}if(Dr.cursor=Dr.limit-r,Dr.cursor<=Dr.limit_backward)return!1;Dr.cursor--}return!0}function X(r,i,e){if(Dr.cursor=Dr.limit-r,V()){var n=Dr.limit-Dr.cursor;if(!Dr.eq_s_b(1,i)&&(Dr.cursor=Dr.limit-n,!Dr.eq_s_b(1,e)))return!0;Dr.cursor=Dr.limit-r;var t=Dr.cursor;return Dr.insert(Dr.cursor,Dr.cursor,e),Dr.cursor=t,!1}return!0}function Y(){var r=Dr.limit-Dr.cursor;(Dr.eq_s_b(1,"d")||(Dr.cursor=Dr.limit-r,Dr.eq_s_b(1,"g")))&&X(r,"a","ı")&&X(r,"e","i")&&X(r,"o","u")&&X(r,"ö","ü")}function $(){for(var r,i=Dr.cursor,e=2;;){for(r=Dr.cursor;!Dr.in_grouping(Wr,97,305);){if(Dr.cursor>=Dr.limit)return Dr.cursor=r,!(e>0)&&(Dr.cursor=i,!0);Dr.cursor++}e--}}function rr(r,i,e){for(;!Dr.eq_s(i,e);){if(Dr.cursor>=Dr.limit)return!0;Dr.cursor++}return(tr=i)!=Dr.limit||(Dr.cursor=r,!1)}function ir(){var r=Dr.cursor;return!rr(r,2,"ad")||(Dr.cursor=r,!rr(r,5,"soyad"))}function er(){var r=Dr.cursor;return!ir()&&(Dr.limit_backward=r,Dr.cursor=Dr.limit,Y(),Dr.cursor=Dr.limit,U(),!0)}var nr,tr,ur=[new i("m",-1,-1),new i("n",-1,-1),new i("miz",-1,-1),new i("niz",-1,-1),new i("muz",-1,-1),new i("nuz",-1,-1),new i("müz",-1,-1),new i("nüz",-1,-1),new i("mız",-1,-1),new i("nız",-1,-1)],or=[new i("leri",-1,-1),new i("ları",-1,-1)],sr=[new i("ni",-1,-1),new i("nu",-1,-1),new i("nü",-1,-1),new i("nı",-1,-1)],cr=[new i("in",-1,-1),new i("un",-1,-1),new i("ün",-1,-1),new i("ın",-1,-1)],lr=[new i("a",-1,-1),new i("e",-1,-1)],ar=[new i("na",-1,-1),new i("ne",-1,-1)],mr=[new i("da",-1,-1),new i("ta",-1,-1),new i("de",-1,-1),new i("te",-1,-1)],dr=[new i("nda",-1,-1),new i("nde",-1,-1)],fr=[new i("dan",-1,-1),new i("tan",-1,-1),new i("den",-1,-1),new i("ten",-1,-1)],br=[new i("ndan",-1,-1),new i("nden",-1,-1)],wr=[new i("la",-1,-1),new i("le",-1,-1)],_r=[new i("ca",-1,-1),new i("ce",-1,-1)],kr=[new i("im",-1,-1),new i("um",-1,-1),new i("üm",-1,-1),new i("ım",-1,-1)],pr=[new i("sin",-1,-1),new i("sun",-1,-1),new i("sün",-1,-1),new i("sın",-1,-1)],gr=[new i("iz",-1,-1),new i("uz",-1,-1),new i("üz",-1,-1),new i("ız",-1,-1)],yr=[new i("siniz",-1,-1),new i("sunuz",-1,-1),new i("sünüz",-1,-1),new i("sınız",-1,-1)],zr=[new i("lar",-1,-1),new i("ler",-1,-1)],vr=[new i("niz",-1,-1),new i("nuz",-1,-1),new i("nüz",-1,-1),new i("nız",-1,-1)],hr=[new i("dir",-1,-1),new i("tir",-1,-1),new i("dur",-1,-1),new i("tur",-1,-1),new i("dür",-1,-1),new i("tür",-1,-1),new i("dır",-1,-1),new i("tır",-1,-1)],qr=[new i("casına",-1,-1),new i("cesine",-1,-1)],Cr=[new i("di",-1,-1),new i("ti",-1,-1),new i("dik",-1,-1),new i("tik",-1,-1),new i("duk",-1,-1),new i("tuk",-1,-1),new i("dük",-1,-1),new i("tük",-1,-1),new i("dık",-1,-1),new i("tık",-1,-1),new i("dim",-1,-1),new i("tim",-1,-1),new i("dum",-1,-1),new i("tum",-1,-1),new i("düm",-1,-1),new i("tüm",-1,-1),new i("dım",-1,-1),new i("tım",-1,-1),new i("din",-1,-1),new i("tin",-1,-1),new i("dun",-1,-1),new i("tun",-1,-1),new i("dün",-1,-1),new i("tün",-1,-1),new i("dın",-1,-1),new i("tın",-1,-1),new i("du",-1,-1),new i("tu",-1,-1),new i("dü",-1,-1),new i("tü",-1,-1),new i("dı",-1,-1),new i("tı",-1,-1)],Pr=[new i("sa",-1,-1),new i("se",-1,-1),new i("sak",-1,-1),new i("sek",-1,-1),new i("sam",-1,-1),new i("sem",-1,-1),new i("san",-1,-1),new i("sen",-1,-1)],Fr=[new i("miş",-1,-1),new i("muş",-1,-1),new i("müş",-1,-1),new i("mış",-1,-1)],Sr=[new i("b",-1,1),new i("c",-1,2),new i("d",-1,3),new i("ğ",-1,4)],Wr=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,32,8,0,0,0,0,0,0,1],Lr=[1,16,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,8,0,0,0,0,0,0,1],xr=[1,64,16,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1],Ar=[17,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,130],Er=[1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1],jr=[17],Tr=[65],Zr=[65],Br=[["a",xr,97,305],["e",Ar,101,252],["ı",Er,97,305],["i",jr,101,105],["o",Tr,111,117],["ö",Zr,246,252],["u",Tr,111,117]],Dr=new e;this.setCurrent=function(r){Dr.setCurrent(r)},this.getCurrent=function(){return Dr.getCurrent()},this.stem=function(){return!!($()&&(Dr.limit_backward=Dr.cursor,Dr.cursor=Dr.limit,J(),Dr.cursor=Dr.limit,nr&&(R(),Dr.cursor=Dr.limit_backward,er())))}};return function(r){return"function"==typeof r.update?r.update(function(r){return n.setCurrent(r),n.stem(),n.getCurrent()}):(n.setCurrent(r),n.stem(),n.getCurrent())}}(),r.Pipeline.registerFunction(r.tr.stemmer,"stemmer-tr"),r.tr.stopWordFilter=r.generateStopWordFilter("acaba altmış altı ama ancak arada aslında ayrıca bana bazı belki ben benden beni benim beri beş bile bin bir biri birkaç birkez birçok birşey birşeyi biz bizden bize bizi bizim bu buna bunda bundan bunlar bunları bunların bunu bunun burada böyle böylece da daha dahi de defa değil diye diğer doksan dokuz dolayı dolayısıyla dört edecek eden ederek edilecek ediliyor edilmesi ediyor elli en etmesi etti ettiği ettiğini eğer gibi göre halen hangi hatta hem henüz hep hepsi her herhangi herkesin hiç hiçbir iki ile ilgili ise itibaren itibariyle için işte kadar karşın katrilyon kendi kendilerine kendini kendisi kendisine kendisini kez ki kim kimden kime kimi kimse kırk milyar milyon mu mü mı nasıl ne neden nedenle nerde nerede nereye niye niçin o olan olarak oldu olduklarını olduğu olduğunu olmadı olmadığı olmak olması olmayan olmaz olsa olsun olup olur olursa oluyor on ona ondan onlar onlardan onları onların onu onun otuz oysa pek rağmen sadece sanki sekiz seksen sen senden seni senin siz sizden sizi sizin tarafından trilyon tüm var vardı ve veya ya yani yapacak yapmak yaptı yaptıkları yaptığı yaptığını yapılan yapılması yapıyor yedi yerine yetmiş yine yirmi yoksa yüz zaten çok çünkü öyle üzere üç şey şeyden şeyi şeyler şu şuna şunda şundan şunları şunu şöyle".split(" ")),r.Pipeline.registerFunction(r.tr.stopWordFilter,"stopWordFilter-tr")}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/min/lunr.vi.min.js b/v4.2.5/assets/javascripts/lunr/min/lunr.vi.min.js new file mode 100644 index 0000000000..22aed28c49 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/min/lunr.vi.min.js @@ -0,0 +1 @@ +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.vi=function(){this.pipeline.reset(),this.pipeline.add(e.vi.stopWordFilter,e.vi.trimmer)},e.vi.wordCharacters="[A-Za-ẓ̀͐́͑̉̃̓ÂâÊêÔôĂ-ăĐ-đƠ-ơƯ-ư]",e.vi.trimmer=e.trimmerSupport.generateTrimmer(e.vi.wordCharacters),e.Pipeline.registerFunction(e.vi.trimmer,"trimmer-vi"),e.vi.stopWordFilter=e.generateStopWordFilter("là cái nhưng mà".split(" "))}}); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/lunr/tinyseg.js b/v4.2.5/assets/javascripts/lunr/tinyseg.js new file mode 100644 index 0000000000..167fa6dd69 --- /dev/null +++ b/v4.2.5/assets/javascripts/lunr/tinyseg.js @@ -0,0 +1,206 @@ +/** + * export the module via AMD, CommonJS or as a browser global + * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js + */ +;(function (root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. Register as an anonymous module. + define(factory) + } else if (typeof exports === 'object') { + /** + * Node. Does not work with strict CommonJS, but + * only CommonJS-like environments that support module.exports, + * like Node. + */ + module.exports = factory() + } else { + // Browser globals (root is window) + factory()(root.lunr); + } +}(this, function () { + /** + * Just return a value to define the module export. + * This example returns an object, but the module + * can return a function as the exported value. + */ + + return function(lunr) { + // TinySegmenter 0.1 -- Super compact Japanese tokenizer in Javascript + // (c) 2008 Taku Kudo + // TinySegmenter is freely distributable under the terms of a new BSD licence. + // For details, see http://chasen.org/~taku/software/TinySegmenter/LICENCE.txt + + function TinySegmenter() { + var patterns = { + "[一二三四五六七八九十百千万億兆]":"M", + "[一-龠々〆ヵヶ]":"H", + "[ぁ-ん]":"I", + "[ァ-ヴーｱ-ﾝﾞｰ]":"K", + "[a-zA-Zａ-ｚＡ-Ｚ]":"A", + "[0-9０-９]":"N" + } + this.chartype_ = []; + for (var i in patterns) { + var regexp = new RegExp(i); + this.chartype_.push([regexp, patterns[i]]); + } + + this.BIAS__ = -332 + this.BC1__ = {"HH":6,"II":2461,"KH":406,"OH":-1378}; + this.BC2__ = {"AA":-3267,"AI":2744,"AN":-878,"HH":-4070,"HM":-1711,"HN":4012,"HO":3761,"IA":1327,"IH":-1184,"II":-1332,"IK":1721,"IO":5492,"KI":3831,"KK":-8741,"MH":-3132,"MK":3334,"OO":-2920}; + this.BC3__ = {"HH":996,"HI":626,"HK":-721,"HN":-1307,"HO":-836,"IH":-301,"KK":2762,"MK":1079,"MM":4034,"OA":-1652,"OH":266}; + this.BP1__ = {"BB":295,"OB":304,"OO":-125,"UB":352}; + this.BP2__ = {"BO":60,"OO":-1762}; + this.BQ1__ = {"BHH":1150,"BHM":1521,"BII":-1158,"BIM":886,"BMH":1208,"BNH":449,"BOH":-91,"BOO":-2597,"OHI":451,"OIH":-296,"OKA":1851,"OKH":-1020,"OKK":904,"OOO":2965}; + this.BQ2__ = {"BHH":118,"BHI":-1159,"BHM":466,"BIH":-919,"BKK":-1720,"BKO":864,"OHH":-1139,"OHM":-181,"OIH":153,"UHI":-1146}; + this.BQ3__ = {"BHH":-792,"BHI":2664,"BII":-299,"BKI":419,"BMH":937,"BMM":8335,"BNN":998,"BOH":775,"OHH":2174,"OHM":439,"OII":280,"OKH":1798,"OKI":-793,"OKO":-2242,"OMH":-2402,"OOO":11699}; + this.BQ4__ = {"BHH":-3895,"BIH":3761,"BII":-4654,"BIK":1348,"BKK":-1806,"BMI":-3385,"BOO":-12396,"OAH":926,"OHH":266,"OHK":-2036,"ONN":-973}; + this.BW1__ = {",と":660,",同":727,"B1あ":1404,"B1同":542,"、と":660,"、同":727,"」と":1682,"あっ":1505,"いう":1743,"いっ":-2055,"いる":672,"うし":-4817,"うん":665,"から":3472,"がら":600,"こう":-790,"こと":2083,"こん":-1262,"さら":-4143,"さん":4573,"した":2641,"して":1104,"すで":-3399,"そこ":1977,"それ":-871,"たち":1122,"ため":601,"った":3463,"つい":-802,"てい":805,"てき":1249,"でき":1127,"です":3445,"では":844,"とい":-4915,"とみ":1922,"どこ":3887,"ない":5713,"なっ":3015,"など":7379,"なん":-1113,"にし":2468,"には":1498,"にも":1671,"に対":-912,"の一":-501,"の中":741,"ませ":2448,"まで":1711,"まま":2600,"まる":-2155,"やむ":-1947,"よっ":-2565,"れた":2369,"れで":-913,"をし":1860,"を見":731,"亡く":-1886,"京都":2558,"取り":-2784,"大き":-2604,"大阪":1497,"平方":-2314,"引き":-1336,"日本":-195,"本当":-2423,"毎日":-2113,"目指":-724,"Ｂ１あ":1404,"Ｂ１同":542,"｣と":1682}; + this.BW2__ = {"..":-11822,"11":-669,"――":-5730,"−−":-13175,"いう":-1609,"うか":2490,"かし":-1350,"かも":-602,"から":-7194,"かれ":4612,"がい":853,"がら":-3198,"きた":1941,"くな":-1597,"こと":-8392,"この":-4193,"させ":4533,"され":13168,"さん":-3977,"しい":-1819,"しか":-545,"した":5078,"して":972,"しな":939,"その":-3744,"たい":-1253,"たた":-662,"ただ":-3857,"たち":-786,"たと":1224,"たは":-939,"った":4589,"って":1647,"っと":-2094,"てい":6144,"てき":3640,"てく":2551,"ては":-3110,"ても":-3065,"でい":2666,"でき":-1528,"でし":-3828,"です":-4761,"でも":-4203,"とい":1890,"とこ":-1746,"とと":-2279,"との":720,"とみ":5168,"とも":-3941,"ない":-2488,"なが":-1313,"など":-6509,"なの":2614,"なん":3099,"にお":-1615,"にし":2748,"にな":2454,"によ":-7236,"に対":-14943,"に従":-4688,"に関":-11388,"のか":2093,"ので":-7059,"のに":-6041,"のの":-6125,"はい":1073,"はが":-1033,"はず":-2532,"ばれ":1813,"まし":-1316,"まで":-6621,"まれ":5409,"めて":-3153,"もい":2230,"もの":-10713,"らか":-944,"らし":-1611,"らに":-1897,"りし":651,"りま":1620,"れた":4270,"れて":849,"れば":4114,"ろう":6067,"われ":7901,"を通":-11877,"んだ":728,"んな":-4115,"一人":602,"一方":-1375,"一日":970,"一部":-1051,"上が":-4479,"会社":-1116,"出て":2163,"分の":-7758,"同党":970,"同日":-913,"大阪":-2471,"委員":-1250,"少な":-1050,"年度":-8669,"年間":-1626,"府県":-2363,"手権":-1982,"新聞":-4066,"日新":-722,"日本":-7068,"日米":3372,"曜日":-601,"朝鮮":-2355,"本人":-2697,"東京":-1543,"然と":-1384,"社会":-1276,"立て":-990,"第に":-1612,"米国":-4268,"１１":-669}; + this.BW3__ = {"あた":-2194,"あり":719,"ある":3846,"い.":-1185,"い。":-1185,"いい":5308,"いえ":2079,"いく":3029,"いた":2056,"いっ":1883,"いる":5600,"いわ":1527,"うち":1117,"うと":4798,"えと":1454,"か.":2857,"か。":2857,"かけ":-743,"かっ":-4098,"かに":-669,"から":6520,"かり":-2670,"が,":1816,"が、":1816,"がき":-4855,"がけ":-1127,"がっ":-913,"がら":-4977,"がり":-2064,"きた":1645,"けど":1374,"こと":7397,"この":1542,"ころ":-2757,"さい":-714,"さを":976,"し,":1557,"し、":1557,"しい":-3714,"した":3562,"して":1449,"しな":2608,"しま":1200,"す.":-1310,"す。":-1310,"する":6521,"ず,":3426,"ず、":3426,"ずに":841,"そう":428,"た.":8875,"た。":8875,"たい":-594,"たの":812,"たり":-1183,"たる":-853,"だ.":4098,"だ。":4098,"だっ":1004,"った":-4748,"って":300,"てい":6240,"てお":855,"ても":302,"です":1437,"でに":-1482,"では":2295,"とう":-1387,"とし":2266,"との":541,"とも":-3543,"どう":4664,"ない":1796,"なく":-903,"など":2135,"に,":-1021,"に、":-1021,"にし":1771,"にな":1906,"には":2644,"の,":-724,"の、":-724,"の子":-1000,"は,":1337,"は、":1337,"べき":2181,"まし":1113,"ます":6943,"まっ":-1549,"まで":6154,"まれ":-793,"らし":1479,"られ":6820,"るる":3818,"れ,":854,"れ、":854,"れた":1850,"れて":1375,"れば":-3246,"れる":1091,"われ":-605,"んだ":606,"んで":798,"カ月":990,"会議":860,"入り":1232,"大会":2217,"始め":1681,"市":965,"新聞":-5055,"日,":974,"日、":974,"社会":2024,"ｶ月":990}; + this.TC1__ = {"AAA":1093,"HHH":1029,"HHM":580,"HII":998,"HOH":-390,"HOM":-331,"IHI":1169,"IOH":-142,"IOI":-1015,"IOM":467,"MMH":187,"OOI":-1832}; + this.TC2__ = {"HHO":2088,"HII":-1023,"HMM":-1154,"IHI":-1965,"KKH":703,"OII":-2649}; + this.TC3__ = {"AAA":-294,"HHH":346,"HHI":-341,"HII":-1088,"HIK":731,"HOH":-1486,"IHH":128,"IHI":-3041,"IHO":-1935,"IIH":-825,"IIM":-1035,"IOI":-542,"KHH":-1216,"KKA":491,"KKH":-1217,"KOK":-1009,"MHH":-2694,"MHM":-457,"MHO":123,"MMH":-471,"NNH":-1689,"NNO":662,"OHO":-3393}; + this.TC4__ = {"HHH":-203,"HHI":1344,"HHK":365,"HHM":-122,"HHN":182,"HHO":669,"HIH":804,"HII":679,"HOH":446,"IHH":695,"IHO":-2324,"IIH":321,"III":1497,"IIO":656,"IOO":54,"KAK":4845,"KKA":3386,"KKK":3065,"MHH":-405,"MHI":201,"MMH":-241,"MMM":661,"MOM":841}; + this.TQ1__ = {"BHHH":-227,"BHHI":316,"BHIH":-132,"BIHH":60,"BIII":1595,"BNHH":-744,"BOHH":225,"BOOO":-908,"OAKK":482,"OHHH":281,"OHIH":249,"OIHI":200,"OIIH":-68}; + this.TQ2__ = {"BIHH":-1401,"BIII":-1033,"BKAK":-543,"BOOO":-5591}; + this.TQ3__ = {"BHHH":478,"BHHM":-1073,"BHIH":222,"BHII":-504,"BIIH":-116,"BIII":-105,"BMHI":-863,"BMHM":-464,"BOMH":620,"OHHH":346,"OHHI":1729,"OHII":997,"OHMH":481,"OIHH":623,"OIIH":1344,"OKAK":2792,"OKHH":587,"OKKA":679,"OOHH":110,"OOII":-685}; + this.TQ4__ = {"BHHH":-721,"BHHM":-3604,"BHII":-966,"BIIH":-607,"BIII":-2181,"OAAA":-2763,"OAKK":180,"OHHH":-294,"OHHI":2446,"OHHO":480,"OHIH":-1573,"OIHH":1935,"OIHI":-493,"OIIH":626,"OIII":-4007,"OKAK":-8156}; + this.TW1__ = {"につい":-4681,"東京都":2026}; + this.TW2__ = {"ある程":-2049,"いった":-1256,"ころが":-2434,"しょう":3873,"その後":-4430,"だって":-1049,"ていた":1833,"として":-4657,"ともに":-4517,"もので":1882,"一気に":-792,"初めて":-1512,"同時に":-8097,"大きな":-1255,"対して":-2721,"社会党":-3216}; + this.TW3__ = {"いただ":-1734,"してい":1314,"として":-4314,"につい":-5483,"にとっ":-5989,"に当た":-6247,"ので,":-727,"ので、":-727,"のもの":-600,"れから":-3752,"十二月":-2287}; + this.TW4__ = {"いう.":8576,"いう。":8576,"からな":-2348,"してい":2958,"たが,":1516,"たが、":1516,"ている":1538,"という":1349,"ました":5543,"ません":1097,"ようと":-4258,"よると":5865}; + this.UC1__ = {"A":484,"K":93,"M":645,"O":-505}; + this.UC2__ = {"A":819,"H":1059,"I":409,"M":3987,"N":5775,"O":646}; + this.UC3__ = {"A":-1370,"I":2311}; + this.UC4__ = {"A":-2643,"H":1809,"I":-1032,"K":-3450,"M":3565,"N":3876,"O":6646}; + this.UC5__ = {"H":313,"I":-1238,"K":-799,"M":539,"O":-831}; + this.UC6__ = {"H":-506,"I":-253,"K":87,"M":247,"O":-387}; + this.UP1__ = {"O":-214}; + this.UP2__ = {"B":69,"O":935}; + this.UP3__ = {"B":189}; + this.UQ1__ = {"BH":21,"BI":-12,"BK":-99,"BN":142,"BO":-56,"OH":-95,"OI":477,"OK":410,"OO":-2422}; + this.UQ2__ = {"BH":216,"BI":113,"OK":1759}; + this.UQ3__ = {"BA":-479,"BH":42,"BI":1913,"BK":-7198,"BM":3160,"BN":6427,"BO":14761,"OI":-827,"ON":-3212}; + this.UW1__ = {",":156,"、":156,"「":-463,"あ":-941,"う":-127,"が":-553,"き":121,"こ":505,"で":-201,"と":-547,"ど":-123,"に":-789,"の":-185,"は":-847,"も":-466,"や":-470,"よ":182,"ら":-292,"り":208,"れ":169,"を":-446,"ん":-137,"・":-135,"主":-402,"京":-268,"区":-912,"午":871,"国":-460,"大":561,"委":729,"市":-411,"日":-141,"理":361,"生":-408,"県":-386,"都":-718,"｢":-463,"･":-135}; + this.UW2__ = {",":-829,"、":-829,"〇":892,"「":-645,"」":3145,"あ":-538,"い":505,"う":134,"お":-502,"か":1454,"が":-856,"く":-412,"こ":1141,"さ":878,"ざ":540,"し":1529,"す":-675,"せ":300,"そ":-1011,"た":188,"だ":1837,"つ":-949,"て":-291,"で":-268,"と":-981,"ど":1273,"な":1063,"に":-1764,"の":130,"は":-409,"ひ":-1273,"べ":1261,"ま":600,"も":-1263,"や":-402,"よ":1639,"り":-579,"る":-694,"れ":571,"を":-2516,"ん":2095,"ア":-587,"カ":306,"キ":568,"ッ":831,"三":-758,"不":-2150,"世":-302,"中":-968,"主":-861,"事":492,"人":-123,"会":978,"保":362,"入":548,"初":-3025,"副":-1566,"北":-3414,"区":-422,"大":-1769,"天":-865,"太":-483,"子":-1519,"学":760,"実":1023,"小":-2009,"市":-813,"年":-1060,"強":1067,"手":-1519,"揺":-1033,"政":1522,"文":-1355,"新":-1682,"日":-1815,"明":-1462,"最":-630,"朝":-1843,"本":-1650,"東":-931,"果":-665,"次":-2378,"民":-180,"気":-1740,"理":752,"発":529,"目":-1584,"相":-242,"県":-1165,"立":-763,"第":810,"米":509,"自":-1353,"行":838,"西":-744,"見":-3874,"調":1010,"議":1198,"込":3041,"開":1758,"間":-1257,"｢":-645,"｣":3145,"ｯ":831,"ｱ":-587,"ｶ":306,"ｷ":568}; + this.UW3__ = {",":4889,"1":-800,"−":-1723,"、":4889,"々":-2311,"〇":5827,"」":2670,"〓":-3573,"あ":-2696,"い":1006,"う":2342,"え":1983,"お":-4864,"か":-1163,"が":3271,"く":1004,"け":388,"げ":401,"こ":-3552,"ご":-3116,"さ":-1058,"し":-395,"す":584,"せ":3685,"そ":-5228,"た":842,"ち":-521,"っ":-1444,"つ":-1081,"て":6167,"で":2318,"と":1691,"ど":-899,"な":-2788,"に":2745,"の":4056,"は":4555,"ひ":-2171,"ふ":-1798,"へ":1199,"ほ":-5516,"ま":-4384,"み":-120,"め":1205,"も":2323,"や":-788,"よ":-202,"ら":727,"り":649,"る":5905,"れ":2773,"わ":-1207,"を":6620,"ん":-518,"ア":551,"グ":1319,"ス":874,"ッ":-1350,"ト":521,"ム":1109,"ル":1591,"ロ":2201,"ン":278,"・":-3794,"一":-1619,"下":-1759,"世":-2087,"両":3815,"中":653,"主":-758,"予":-1193,"二":974,"人":2742,"今":792,"他":1889,"以":-1368,"低":811,"何":4265,"作":-361,"保":-2439,"元":4858,"党":3593,"全":1574,"公":-3030,"六":755,"共":-1880,"円":5807,"再":3095,"分":457,"初":2475,"別":1129,"前":2286,"副":4437,"力":365,"動":-949,"務":-1872,"化":1327,"北":-1038,"区":4646,"千":-2309,"午":-783,"協":-1006,"口":483,"右":1233,"各":3588,"合":-241,"同":3906,"和":-837,"員":4513,"国":642,"型":1389,"場":1219,"外":-241,"妻":2016,"学":-1356,"安":-423,"実":-1008,"家":1078,"小":-513,"少":-3102,"州":1155,"市":3197,"平":-1804,"年":2416,"広":-1030,"府":1605,"度":1452,"建":-2352,"当":-3885,"得":1905,"思":-1291,"性":1822,"戸":-488,"指":-3973,"政":-2013,"教":-1479,"数":3222,"文":-1489,"新":1764,"日":2099,"旧":5792,"昨":-661,"時":-1248,"曜":-951,"最":-937,"月":4125,"期":360,"李":3094,"村":364,"東":-805,"核":5156,"森":2438,"業":484,"氏":2613,"民":-1694,"決":-1073,"法":1868,"海":-495,"無":979,"物":461,"特":-3850,"生":-273,"用":914,"町":1215,"的":7313,"直":-1835,"省":792,"県":6293,"知":-1528,"私":4231,"税":401,"立":-960,"第":1201,"米":7767,"系":3066,"約":3663,"級":1384,"統":-4229,"総":1163,"線":1255,"者":6457,"能":725,"自":-2869,"英":785,"見":1044,"調":-562,"財":-733,"費":1777,"車":1835,"軍":1375,"込":-1504,"通":-1136,"選":-681,"郎":1026,"郡":4404,"部":1200,"金":2163,"長":421,"開":-1432,"間":1302,"関":-1282,"雨":2009,"電":-1045,"非":2066,"駅":1620,"１":-800,"｣":2670,"･":-3794,"ｯ":-1350,"ｱ":551,"ｸﾞ":1319,"ｽ":874,"ﾄ":521,"ﾑ":1109,"ﾙ":1591,"ﾛ":2201,"ﾝ":278}; + this.UW4__ = {",":3930,".":3508,"―":-4841,"、":3930,"。":3508,"〇":4999,"「":1895,"」":3798,"〓":-5156,"あ":4752,"い":-3435,"う":-640,"え":-2514,"お":2405,"か":530,"が":6006,"き":-4482,"ぎ":-3821,"く":-3788,"け":-4376,"げ":-4734,"こ":2255,"ご":1979,"さ":2864,"し":-843,"じ":-2506,"す":-731,"ず":1251,"せ":181,"そ":4091,"た":5034,"だ":5408,"ち":-3654,"っ":-5882,"つ":-1659,"て":3994,"で":7410,"と":4547,"な":5433,"に":6499,"ぬ":1853,"ね":1413,"の":7396,"は":8578,"ば":1940,"ひ":4249,"び":-4134,"ふ":1345,"へ":6665,"べ":-744,"ほ":1464,"ま":1051,"み":-2082,"む":-882,"め":-5046,"も":4169,"ゃ":-2666,"や":2795,"ょ":-1544,"よ":3351,"ら":-2922,"り":-9726,"る":-14896,"れ":-2613,"ろ":-4570,"わ":-1783,"を":13150,"ん":-2352,"カ":2145,"コ":1789,"セ":1287,"ッ":-724,"ト":-403,"メ":-1635,"ラ":-881,"リ":-541,"ル":-856,"ン":-3637,"・":-4371,"ー":-11870,"一":-2069,"中":2210,"予":782,"事":-190,"井":-1768,"人":1036,"以":544,"会":950,"体":-1286,"作":530,"側":4292,"先":601,"党":-2006,"共":-1212,"内":584,"円":788,"初":1347,"前":1623,"副":3879,"力":-302,"動":-740,"務":-2715,"化":776,"区":4517,"協":1013,"参":1555,"合":-1834,"和":-681,"員":-910,"器":-851,"回":1500,"国":-619,"園":-1200,"地":866,"場":-1410,"塁":-2094,"士":-1413,"多":1067,"大":571,"子":-4802,"学":-1397,"定":-1057,"寺":-809,"小":1910,"屋":-1328,"山":-1500,"島":-2056,"川":-2667,"市":2771,"年":374,"庁":-4556,"後":456,"性":553,"感":916,"所":-1566,"支":856,"改":787,"政":2182,"教":704,"文":522,"方":-856,"日":1798,"時":1829,"最":845,"月":-9066,"木":-485,"来":-442,"校":-360,"業":-1043,"氏":5388,"民":-2716,"気":-910,"沢":-939,"済":-543,"物":-735,"率":672,"球":-1267,"生":-1286,"産":-1101,"田":-2900,"町":1826,"的":2586,"目":922,"省":-3485,"県":2997,"空":-867,"立":-2112,"第":788,"米":2937,"系":786,"約":2171,"経":1146,"統":-1169,"総":940,"線":-994,"署":749,"者":2145,"能":-730,"般":-852,"行":-792,"規":792,"警":-1184,"議":-244,"谷":-1000,"賞":730,"車":-1481,"軍":1158,"輪":-1433,"込":-3370,"近":929,"道":-1291,"選":2596,"郎":-4866,"都":1192,"野":-1100,"銀":-2213,"長":357,"間":-2344,"院":-2297,"際":-2604,"電":-878,"領":-1659,"題":-792,"館":-1984,"首":1749,"高":2120,"｢":1895,"｣":3798,"･":-4371,"ｯ":-724,"ｰ":-11870,"ｶ":2145,"ｺ":1789,"ｾ":1287,"ﾄ":-403,"ﾒ":-1635,"ﾗ":-881,"ﾘ":-541,"ﾙ":-856,"ﾝ":-3637}; + this.UW5__ = {",":465,".":-299,"1":-514,"E2":-32768,"]":-2762,"、":465,"。":-299,"「":363,"あ":1655,"い":331,"う":-503,"え":1199,"お":527,"か":647,"が":-421,"き":1624,"ぎ":1971,"く":312,"げ":-983,"さ":-1537,"し":-1371,"す":-852,"だ":-1186,"ち":1093,"っ":52,"つ":921,"て":-18,"で":-850,"と":-127,"ど":1682,"な":-787,"に":-1224,"の":-635,"は":-578,"べ":1001,"み":502,"め":865,"ゃ":3350,"ょ":854,"り":-208,"る":429,"れ":504,"わ":419,"を":-1264,"ん":327,"イ":241,"ル":451,"ン":-343,"中":-871,"京":722,"会":-1153,"党":-654,"務":3519,"区":-901,"告":848,"員":2104,"大":-1296,"学":-548,"定":1785,"嵐":-1304,"市":-2991,"席":921,"年":1763,"思":872,"所":-814,"挙":1618,"新":-1682,"日":218,"月":-4353,"査":932,"格":1356,"機":-1508,"氏":-1347,"田":240,"町":-3912,"的":-3149,"相":1319,"省":-1052,"県":-4003,"研":-997,"社":-278,"空":-813,"統":1955,"者":-2233,"表":663,"語":-1073,"議":1219,"選":-1018,"郎":-368,"長":786,"間":1191,"題":2368,"館":-689,"１":-514,"Ｅ２":-32768,"｢":363,"ｲ":241,"ﾙ":451,"ﾝ":-343}; + this.UW6__ = {",":227,".":808,"1":-270,"E1":306,"、":227,"。":808,"あ":-307,"う":189,"か":241,"が":-73,"く":-121,"こ":-200,"じ":1782,"す":383,"た":-428,"っ":573,"て":-1014,"で":101,"と":-105,"な":-253,"に":-149,"の":-417,"は":-236,"も":-206,"り":187,"る":-135,"を":195,"ル":-673,"ン":-496,"一":-277,"中":201,"件":-800,"会":624,"前":302,"区":1792,"員":-1212,"委":798,"学":-960,"市":887,"広":-695,"後":535,"業":-697,"相":753,"社":-507,"福":974,"空":-822,"者":1811,"連":463,"郎":1082,"１":-270,"Ｅ１":306,"ﾙ":-673,"ﾝ":-496}; + + return this; + } + TinySegmenter.prototype.ctype_ = function(str) { + for (var i in this.chartype_) { + if (str.match(this.chartype_[i][0])) { + return this.chartype_[i][1]; + } + } + return "O"; + } + + TinySegmenter.prototype.ts_ = function(v) { + if (v) { return v; } + return 0; + } + + TinySegmenter.prototype.segment = function(input) { + if (input == null || input == undefined || input == "") { + return []; + } + var result = []; + var seg = ["B3","B2","B1"]; + var ctype = ["O","O","O"]; + var o = input.split(""); + for (i = 0; i < o.length; ++i) { + seg.push(o[i]); + ctype.push(this.ctype_(o[i])) + } + seg.push("E1"); + seg.push("E2"); + seg.push("E3"); + ctype.push("O"); + ctype.push("O"); + ctype.push("O"); + var word = seg[3]; + var p1 = "U"; + var p2 = "U"; + var p3 = "U"; + for (var i = 4; i < seg.length - 3; ++i) { + var score = this.BIAS__; + var w1 = seg[i-3]; + var w2 = seg[i-2]; + var w3 = seg[i-1]; + var w4 = seg[i]; + var w5 = seg[i+1]; + var w6 = seg[i+2]; + var c1 = ctype[i-3]; + var c2 = ctype[i-2]; + var c3 = ctype[i-1]; + var c4 = ctype[i]; + var c5 = ctype[i+1]; + var c6 = ctype[i+2]; + score += this.ts_(this.UP1__[p1]); + score += this.ts_(this.UP2__[p2]); + score += this.ts_(this.UP3__[p3]); + score += this.ts_(this.BP1__[p1 + p2]); + score += this.ts_(this.BP2__[p2 + p3]); + score += this.ts_(this.UW1__[w1]); + score += this.ts_(this.UW2__[w2]); + score += this.ts_(this.UW3__[w3]); + score += this.ts_(this.UW4__[w4]); + score += this.ts_(this.UW5__[w5]); + score += this.ts_(this.UW6__[w6]); + score += this.ts_(this.BW1__[w2 + w3]); + score += this.ts_(this.BW2__[w3 + w4]); + score += this.ts_(this.BW3__[w4 + w5]); + score += this.ts_(this.TW1__[w1 + w2 + w3]); + score += this.ts_(this.TW2__[w2 + w3 + w4]); + score += this.ts_(this.TW3__[w3 + w4 + w5]); + score += this.ts_(this.TW4__[w4 + w5 + w6]); + score += this.ts_(this.UC1__[c1]); + score += this.ts_(this.UC2__[c2]); + score += this.ts_(this.UC3__[c3]); + score += this.ts_(this.UC4__[c4]); + score += this.ts_(this.UC5__[c5]); + score += this.ts_(this.UC6__[c6]); + score += this.ts_(this.BC1__[c2 + c3]); + score += this.ts_(this.BC2__[c3 + c4]); + score += this.ts_(this.BC3__[c4 + c5]); + score += this.ts_(this.TC1__[c1 + c2 + c3]); + score += this.ts_(this.TC2__[c2 + c3 + c4]); + score += this.ts_(this.TC3__[c3 + c4 + c5]); + score += this.ts_(this.TC4__[c4 + c5 + c6]); + // score += this.ts_(this.TC5__[c4 + c5 + c6]); + score += this.ts_(this.UQ1__[p1 + c1]); + score += this.ts_(this.UQ2__[p2 + c2]); + score += this.ts_(this.UQ3__[p3 + c3]); + score += this.ts_(this.BQ1__[p2 + c2 + c3]); + score += this.ts_(this.BQ2__[p2 + c3 + c4]); + score += this.ts_(this.BQ3__[p3 + c2 + c3]); + score += this.ts_(this.BQ4__[p3 + c3 + c4]); + score += this.ts_(this.TQ1__[p2 + c1 + c2 + c3]); + score += this.ts_(this.TQ2__[p2 + c2 + c3 + c4]); + score += this.ts_(this.TQ3__[p3 + c1 + c2 + c3]); + score += this.ts_(this.TQ4__[p3 + c2 + c3 + c4]); + var p = "O"; + if (score > 0) { + result.push(word); + word = ""; + p = "B"; + } + p1 = p2; + p2 = p3; + p3 = p; + word += seg[i]; + } + result.push(word); + + return result; + } + + lunr.TinySegmenter = TinySegmenter; + }; + +})); \ No newline at end of file diff --git a/v4.2.5/assets/javascripts/workers/search.df8cae7d.min.js b/v4.2.5/assets/javascripts/workers/search.df8cae7d.min.js new file mode 100644 index 0000000000..4197eccca3 --- /dev/null +++ b/v4.2.5/assets/javascripts/workers/search.df8cae7d.min.js @@ -0,0 +1,59 @@ +(()=>{var ge=Object.create,U=Object.defineProperty,ye=Object.defineProperties,me=Object.getOwnPropertyDescriptor,ve=Object.getOwnPropertyDescriptors,xe=Object.getOwnPropertyNames,Y=Object.getOwnPropertySymbols,Se=Object.getPrototypeOf,G=Object.prototype.hasOwnProperty,Qe=Object.prototype.propertyIsEnumerable;var J=(t,e,r)=>e in t?U(t,e,{enumerable:!0,configurable:!0,writable:!0,value:r}):t[e]=r,j=(t,e)=>{for(var r in e||(e={}))G.call(e,r)&&J(t,r,e[r]);if(Y)for(var r of Y(e))Qe.call(e,r)&&J(t,r,e[r]);return t},X=(t,e)=>ye(t,ve(e)),be=t=>U(t,"__esModule",{value:!0});var Z=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var we=(t,e,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of xe(e))!G.call(t,n)&&n!=="default"&&U(t,n,{get:()=>e[n],enumerable:!(r=me(e,n))||r.enumerable});return t},K=t=>we(be(U(t!=null?ge(Se(t)):{},"default",t&&t.__esModule&&"default"in t?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var W=(t,e,r)=>new Promise((n,i)=>{var s=u=>{try{a(r.next(u))}catch(c){i(c)}},o=u=>{try{a(r.throw(u))}catch(c){i(c)}},a=u=>u.done?n(u.value):Promise.resolve(u.value).then(s,o);a((r=r.apply(t,e)).next())});var re=Z((ee,te)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,c],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[c+1]*i[h+1],c+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),y=s.str.charAt(1),g;y in s.node.edges?g=s.node.edges[y]:(g=new t.TokenSet,s.node.edges[y]=g),s.str.length==1&&(g.final=!0),i.push({node:g,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof ee=="object"?te.exports=r():e.lunr=r()}(this,function(){return t})})()});var ie=Z((Te,ne)=>{"use strict";var Le=/["'&<>]/;ne.exports=Ee;function Ee(t){var e=""+t,r=Le.exec(e);if(!r)return e;var n,i="",s=0,o=0;for(s=r.index;s`${i}${s}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${t.separator})(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(e,"|")})`,"img");return s=>s.replace(i,r).replace(/<\/mark>(\s+)]*>/img,"$1")}}function ue(t){let e=new lunr.Query(["title","text"]);return new lunr.QueryParser(t,e).parse(),e.clauses}function ce(t,e){let r=new Set(t),n={};for(let i=0;i!n.has(i)))]}var q=class{constructor({config:e,docs:r,index:n,options:i}){this.options=i,this.documents=oe(r),this.highlight=ae(e),lunr.tokenizer.separator=new RegExp(e.separator),typeof n=="undefined"?this.index=lunr(function(){e.lang.length===1&&e.lang[0]!=="en"?this.use(lunr[e.lang[0]]):e.lang.length>1&&this.use(lunr.multiLanguage(...e.lang));let s=ke(["trimmer","stopWordFilter","stemmer"],i.pipeline);for(let o of e.lang.map(a=>a==="en"?lunr:lunr[a]))for(let a of s)this.pipeline.remove(o[a]),this.searchPipeline.remove(o[a]);this.ref("location"),this.field("title",{boost:1e3}),this.field("text"),this.field("tags",{boost:1e6});for(let o of r)this.add(o,{boost:o.boost})}):this.index=lunr.Index.load(n)}search(e){if(e)try{let r=this.highlight(e),n=ue(e).filter(o=>o.presence!==lunr.Query.presence.PROHIBITED),i=this.index.search(`${e}*`).reduce((o,{ref:a,score:u,matchData:c})=>{let h=this.documents.get(a);if(typeof h!="undefined"){let{location:y,title:g,text:b,tags:m,parent:Q}=h,f=ce(n,Object.keys(c.metadata)),p=+!Q+ +Object.values(f).every(L=>L);o.push(X(j({location:y,title:r(g),text:r(b)},m&&{tags:m.map(r)}),{score:u*(1+p),terms:f}))}return o},[]).sort((o,a)=>a.score-o.score).reduce((o,a)=>{let u=this.documents.get(a.location);if(typeof u!="undefined"){let c="parent"in u?u.parent.location:u.location;o.set(c,[...o.get(c)||[],a])}return o},new Map),s;if(this.options.suggestions){let o=this.index.query(a=>{for(let u of n)a.term(u.term,{fields:["title"],presence:lunr.Query.presence.REQUIRED,wildcard:lunr.Query.wildcard.TRAILING})});s=o.length?Object.keys(o[0].matchData.metadata):[]}return j({items:[...i.values()]},typeof s!="undefined"&&{suggestions:s})}catch(r){console.warn(`Invalid query: ${e} \u2013 see https://bit.ly/2s3ChXG`)}return{items:[]}}};var T;(function(i){i[i.SETUP=0]="SETUP",i[i.READY=1]="READY",i[i.QUERY=2]="QUERY",i[i.RESULT=3]="RESULT"})(T||(T={}));var H;function Pe(t){return W(this,null,function*(){let e="../lunr";if(typeof parent!="undefined"&&"IFrameWorker"in parent){let n=document.querySelector("script[src]"),[i]=n.src.split("/worker");e=e.replace("..",i)}let r=[];for(let n of t.lang)n==="ja"&&r.push(`${e}/tinyseg.js`),n!=="en"&&r.push(`${e}/min/lunr.${n}.min.js`);t.lang.length>1&&r.push(`${e}/min/lunr.multi.min.js`),r.length&&(yield importScripts(`${e}/min/lunr.stemmer.support.min.js`,...r))})}function Ie(t){return W(this,null,function*(){switch(t.type){case T.SETUP:return yield Pe(t.data.config),H=new q(t.data),{type:T.READY};case T.QUERY:return{type:T.RESULT,data:H?H.search(t.data):{items:[]}};default:throw new TypeError("Invalid message type")}})}self.lunr=le.default;addEventListener("message",t=>W(void 0,null,function*(){postMessage(yield Ie(t.data))}));})(); +/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */ +/*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + */ +/*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + */ +/*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + */ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + */ diff --git a/v4.2.5/assets/stylesheets/main.92048cb8.min.css b/v4.2.5/assets/stylesheets/main.92048cb8.min.css new file mode 100644 index 0000000000..d4d59a00ef --- /dev/null +++ b/v4.2.5/assets/stylesheets/main.92048cb8.min.css @@ -0,0 +1 @@ +@charset "UTF-8";html{-webkit-text-size-adjust:none;-ms-text-size-adjust:none;text-size-adjust:none;box-sizing:border-box}*,:after,:before{box-sizing:inherit}body{margin:0}a,button,input,label{-webkit-tap-highlight-color:transparent}a{color:inherit;text-decoration:none}hr{border:0;box-sizing:content-box;display:block;height:.05rem;overflow:visible;padding:0}small{font-size:80%}sub,sup{line-height:1em}img{border-style:none}table{border-collapse:separate;border-spacing:0}td,th{font-weight:400;vertical-align:top}button{background:transparent;border:0;font-family:inherit;font-size:inherit;margin:0;padding:0}input{border:0;outline:none}:root{--md-default-fg-color:rgba(0,0,0,0.87);--md-default-fg-color--light:rgba(0,0,0,0.54);--md-default-fg-color--lighter:rgba(0,0,0,0.32);--md-default-fg-color--lightest:rgba(0,0,0,0.07);--md-default-bg-color:#fff;--md-default-bg-color--light:hsla(0,0%,100%,0.7);--md-default-bg-color--lighter:hsla(0,0%,100%,0.3);--md-default-bg-color--lightest:hsla(0,0%,100%,0.12);--md-primary-fg-color:#4051b5;--md-primary-fg-color--light:#5d6cc0;--md-primary-fg-color--dark:#303fa1;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7);--md-accent-fg-color:#526cfe;--md-accent-fg-color--transparent:rgba(82,108,254,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}:root>*{--md-code-fg-color:#36464e;--md-code-bg-color:#f5f5f5;--md-code-hl-color:rgba(255,255,0,0.5);--md-code-hl-number-color:#d52a2a;--md-code-hl-special-color:#db1457;--md-code-hl-function-color:#a846b9;--md-code-hl-constant-color:#6e59d9;--md-code-hl-keyword-color:#3f6ec6;--md-code-hl-string-color:#1c7d4d;--md-code-hl-name-color:var(--md-code-fg-color);--md-code-hl-operator-color:var(--md-default-fg-color--light);--md-code-hl-punctuation-color:var(--md-default-fg-color--light);--md-code-hl-comment-color:var(--md-default-fg-color--light);--md-code-hl-generic-color:var(--md-default-fg-color--light);--md-code-hl-variable-color:var(--md-default-fg-color--light);--md-typeset-color:var(--md-default-fg-color);--md-typeset-a-color:var(--md-primary-fg-color);--md-typeset-mark-color:rgba(255,255,0,0.5);--md-typeset-del-color:rgba(245,80,61,0.15);--md-typeset-ins-color:rgba(11,213,112,0.15);--md-typeset-kbd-color:#fafafa;--md-typeset-kbd-accent-color:#fff;--md-typeset-kbd-border-color:#b8b8b8;--md-admonition-fg-color:var(--md-default-fg-color);--md-admonition-bg-color:var(--md-default-bg-color);--md-footer-fg-color:#fff;--md-footer-fg-color--light:hsla(0,0%,100%,0.7);--md-footer-fg-color--lighter:hsla(0,0%,100%,0.3);--md-footer-bg-color:rgba(0,0,0,0.87);--md-footer-bg-color--dark:rgba(0,0,0,0.32)}.md-icon svg{fill:currentColor;display:block;height:1.2rem;width:1.2rem}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}aside,body,input{font-feature-settings:"kern","liga";color:var(--md-typeset-color);font-family:var(--md-text-font-family,_),-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-feature-settings:"kern";font-family:var(--md-code-font-family,_),SFMono-Regular,Consolas,Menlo,monospace}:root{--md-typeset-table--ascending:url('data:image/svg+xml;charset=utf-8,');--md-typeset-table--descending:url('data:image/svg+xml;charset=utf-8,')}.md-typeset{-webkit-print-color-adjust:exact;color-adjust:exact;font-size:.8rem;line-height:1.6}@media print{.md-typeset{font-size:.68rem}}.md-typeset blockquote,.md-typeset dl,.md-typeset figure,.md-typeset ol,.md-typeset pre,.md-typeset ul{margin:1em 0}.md-typeset h1{color:var(--md-default-fg-color--light);font-size:2em;line-height:1.3;margin:0 0 1.25em}.md-typeset h1,.md-typeset h2{font-weight:300;letter-spacing:-.01em}.md-typeset h2{font-size:1.5625em;line-height:1.4;margin:1.6em 0 .64em}.md-typeset h3{font-size:1.25em;font-weight:400;letter-spacing:-.01em;line-height:1.5;margin:1.6em 0 .8em}.md-typeset h2+h3{margin-top:.8em}.md-typeset h4{font-weight:700;letter-spacing:-.01em;margin:1em 0}.md-typeset h5,.md-typeset h6{color:var(--md-default-fg-color--light);font-size:.8em;font-weight:700;letter-spacing:-.01em;margin:1.25em 0}.md-typeset h5{text-transform:uppercase}.md-typeset hr{border-bottom:.05rem solid var(--md-default-fg-color--lightest);display:flow-root;margin:1.5em 0}.md-typeset a{color:var(--md-typeset-a-color);word-break:break-word}.md-typeset a,.md-typeset a:before{transition:color 125ms}.md-typeset a:focus,.md-typeset a:hover{color:var(--md-accent-fg-color)}.md-typeset a.focus-visible{outline-color:var(--md-accent-fg-color);outline-offset:.2rem}.md-typeset code,.md-typeset kbd,.md-typeset pre{color:var(--md-code-fg-color);direction:ltr}@media print{.md-typeset code,.md-typeset kbd,.md-typeset pre{white-space:pre-wrap}}.md-typeset code{background-color:var(--md-code-bg-color);border-radius:.1rem;-webkit-box-decoration-break:clone;box-decoration-break:clone;font-size:.85em;padding:0 .2941176471em;word-break:break-word}.md-typeset code:not(.focus-visible){-webkit-tap-highlight-color:transparent;outline:none}.md-typeset h1 code,.md-typeset h2 code,.md-typeset h3 code,.md-typeset h4 code,.md-typeset h5 code,.md-typeset h6 code{background-color:transparent;box-shadow:none;margin:initial;padding:initial}.md-typeset a code{color:currentColor}.md-typeset pre{display:flow-root;line-height:1.4;position:relative}.md-typeset pre>code{-webkit-box-decoration-break:slice;box-decoration-break:slice;box-shadow:none;display:block;margin:0;overflow:auto;padding:.7720588235em 1.1764705882em;scrollbar-color:var(--md-default-fg-color--lighter) transparent;scrollbar-width:thin;touch-action:auto;word-break:normal}.md-typeset pre>code:hover{scrollbar-color:var(--md-accent-fg-color) transparent}.md-typeset pre>code::-webkit-scrollbar{height:.2rem;width:.2rem}.md-typeset pre>code::-webkit-scrollbar-thumb{background-color:var(--md-default-fg-color--lighter)}.md-typeset pre>code::-webkit-scrollbar-thumb:hover{background-color:var(--md-accent-fg-color)}@media screen and (max-width:44.9375em){.md-content>.md-typeset>pre{margin:1em -.8rem}.md-content>.md-typeset>pre code{border-radius:0}}.md-typeset kbd{background-color:var(--md-typeset-kbd-color);border-radius:.1rem;box-shadow:0 .1rem 0 .05rem var(--md-typeset-kbd-border-color),0 .1rem 0 var(--md-typeset-kbd-border-color),0 -.1rem .2rem var(--md-typeset-kbd-accent-color) inset;color:var(--md-default-fg-color);display:inline-block;font-size:.75em;padding:0 .6666666667em;vertical-align:text-top;word-break:break-word}.md-typeset mark{background-color:var(--md-typeset-mark-color);-webkit-box-decoration-break:clone;box-decoration-break:clone;color:inherit;word-break:break-word}.md-typeset abbr{border-bottom:.05rem dotted var(--md-default-fg-color--light);cursor:help;text-decoration:none}@media (hover:none){.md-typeset abbr{position:relative}.md-typeset abbr[title]:focus:after,.md-typeset abbr[title]:hover:after{background-color:var(--md-default-fg-color);border-radius:.1rem;box-shadow:0 2px 2px 0 rgba(0,0,0,.14),0 1px 5px 0 rgba(0,0,0,.12),0 3px 1px -2px rgba(0,0,0,.2);color:var(--md-default-bg-color);content:attr(title);display:inline-block;font-size:.7rem;left:0;margin-top:2em;max-width:80%;min-width:-webkit-max-content;min-width:-moz-max-content;min-width:max-content;padding:.2rem .3rem;position:absolute;width:auto}}.md-typeset small{opacity:.75}.md-typeset sub,.md-typeset sup{margin-left:.078125em}[dir=rtl] .md-typeset sub,[dir=rtl] .md-typeset sup{margin-left:0;margin-right:.078125em}.md-typeset blockquote{border-left:.2rem solid var(--md-default-fg-color--lighter);color:var(--md-default-fg-color--light);display:flow-root;padding-left:.6rem}[dir=rtl] .md-typeset blockquote{border-left:initial;border-right:.2rem solid var(--md-default-fg-color--lighter);padding-left:0;padding-right:.6rem}.md-typeset ul{list-style-type:disc}.md-typeset ol,.md-typeset ul{display:flow-root;margin-left:.625em;padding:0}[dir=rtl] .md-typeset ol,[dir=rtl] .md-typeset ul{margin-left:0;margin-right:.625em}.md-typeset ol ol,.md-typeset ul ol{list-style-type:lower-alpha}.md-typeset ol ol ol,.md-typeset ul ol ol{list-style-type:lower-roman}.md-typeset ol li,.md-typeset ul li{margin-bottom:.5em;margin-left:1.25em}[dir=rtl] .md-typeset ol li,[dir=rtl] .md-typeset ul li{margin-left:0;margin-right:1.25em}.md-typeset ol li blockquote,.md-typeset ol li p,.md-typeset ul li blockquote,.md-typeset ul li p{margin:.5em 0}.md-typeset ol li:last-child,.md-typeset ul li:last-child{margin-bottom:0}.md-typeset ol li ol,.md-typeset ol li ul,.md-typeset ul li ol,.md-typeset ul li ul{margin:.5em 0 .5em .625em}[dir=rtl] .md-typeset ol li ol,[dir=rtl] .md-typeset ol li ul,[dir=rtl] .md-typeset ul li ol,[dir=rtl] .md-typeset ul li ul{margin-left:0;margin-right:.625em}.md-typeset dd{margin:1em 0 1.5em 1.875em}[dir=rtl] .md-typeset dd{margin-left:0;margin-right:1.875em}.md-typeset img,.md-typeset svg{height:auto;max-width:100%}.md-typeset img[align=left],.md-typeset svg[align=left]{margin:1em 1em 1em 0}.md-typeset img[align=right],.md-typeset svg[align=right]{margin:1em 0 1em 1em}.md-typeset img[align]:only-child,.md-typeset svg[align]:only-child{margin-top:0}.md-typeset figure{display:flow-root;margin:0 auto;max-width:100%;text-align:center;width:-webkit-fit-content;width:-moz-fit-content;width:fit-content}.md-typeset figure img{display:block}.md-typeset figcaption{font-style:italic;margin:1em auto 2em;max-width:24rem}.md-typeset iframe{max-width:100%}.md-typeset table:not([class]){background-color:var(--md-default-bg-color);border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .05rem rgba(0,0,0,.1);display:inline-block;font-size:.64rem;max-width:100%;overflow:auto;touch-action:auto}@media print{.md-typeset table:not([class]){display:table}}.md-typeset table:not([class])+*{margin-top:1.5em}.md-typeset table:not([class]) td>:first-child,.md-typeset table:not([class]) th>:first-child{margin-top:0}.md-typeset table:not([class]) td>:last-child,.md-typeset table:not([class]) th>:last-child{margin-bottom:0}.md-typeset table:not([class]) td:not([align]),.md-typeset table:not([class]) th:not([align]){text-align:left}[dir=rtl] .md-typeset table:not([class]) td:not([align]),[dir=rtl] .md-typeset table:not([class]) th:not([align]){text-align:right}.md-typeset table:not([class]) th{background-color:var(--md-default-fg-color--light);color:var(--md-default-bg-color);min-width:5rem;padding:.9375em 1.25em;vertical-align:top}.md-typeset table:not([class]) th a{color:inherit}.md-typeset table:not([class]) td{border-top:.05rem solid var(--md-default-fg-color--lightest);padding:.9375em 1.25em;vertical-align:top}.md-typeset table:not([class]) tr{transition:background-color 125ms}.md-typeset table:not([class]) tr:hover{background-color:rgba(0,0,0,.04);box-shadow:0 .05rem 0 var(--md-default-bg-color) inset}.md-typeset table:not([class]) tr:first-child td{border-top:0}.md-typeset table:not([class]) a{word-break:normal}.md-typeset table th[role=columnheader]{cursor:pointer}.md-typeset table th[role=columnheader]:after{content:"";display:inline-block;height:1.2em;margin-left:.5em;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;vertical-align:sub;width:1.2em}.md-typeset table th[role=columnheader][aria-sort=ascending]:after{background-color:currentColor;-webkit-mask-image:var(--md-typeset-table--ascending);mask-image:var(--md-typeset-table--ascending)}.md-typeset table th[role=columnheader][aria-sort=descending]:after{background-color:currentColor;-webkit-mask-image:var(--md-typeset-table--descending);mask-image:var(--md-typeset-table--descending)}.md-typeset__scrollwrap{margin:1em -.8rem;overflow-x:auto;touch-action:auto}.md-typeset__table{display:inline-block;margin-bottom:.5em;padding:0 .8rem}@media print{.md-typeset__table{display:block}}html .md-typeset__table table{display:table;margin:0;overflow:hidden;width:100%}html{font-size:125%;height:100%;overflow-x:hidden}@media screen and (min-width:100em){html{font-size:137.5%}}@media screen and (min-width:125em){html{font-size:150%}}body{background-color:var(--md-default-bg-color);display:flex;flex-direction:column;font-size:.5rem;min-height:100%;position:relative;width:100%}@media print{body{display:block}}@media screen and (max-width:59.9375em){body[data-md-state=lock]{position:fixed}}.md-grid{margin-left:auto;margin-right:auto;max-width:61rem}.md-container{display:flex;flex-direction:column;flex-grow:1}@media print{.md-container{display:block}}.md-main{flex-grow:1}.md-main__inner{display:flex;height:100%;margin-top:1.5rem}.md-ellipsis{overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.md-toggle{display:none}.md-option{height:0;opacity:0;position:absolute;width:0}.md-option:checked+label:not([hidden]){display:block}.md-option.focus-visible+label{outline-color:var(--md-accent-fg-color);outline-style:auto}.md-skip{background-color:var(--md-default-fg-color);border-radius:.1rem;color:var(--md-default-bg-color);font-size:.64rem;margin:.5rem;opacity:0;outline-color:var(--md-accent-fg-color);padding:.3rem .5rem;position:fixed;transform:translateY(.4rem);z-index:-1}.md-skip:focus{opacity:1;transform:translateY(0);transition:transform .25s cubic-bezier(.4,0,.2,1),opacity 175ms 75ms;z-index:10}@page{margin:25mm}.md-banner{background-color:var(--md-footer-bg-color);color:var(--md-footer-fg-color);overflow:auto}@media print{.md-banner{display:none}}.md-banner--warning{background:var(--md-typeset-mark-color);color:var(--md-default-fg-color)}.md-banner__inner{font-size:.7rem;margin:.6rem auto;padding:0 .8rem}:root{--md-clipboard-icon:url('data:image/svg+xml;charset=utf-8,')}.md-clipboard{border-radius:.1rem;color:var(--md-default-fg-color--lightest);cursor:pointer;height:1.5em;outline-color:var(--md-accent-fg-color);outline-offset:.1rem;position:absolute;right:.5em;top:.5em;transition:color .25s;width:1.5em;z-index:1}@media print{.md-clipboard{display:none}}.md-clipboard:not(.focus-visible){-webkit-tap-highlight-color:transparent;outline:none}:hover>.md-clipboard{color:var(--md-default-fg-color--light)}.md-clipboard:focus,.md-clipboard:hover{color:var(--md-accent-fg-color)}.md-clipboard:after{background-color:currentColor;content:"";display:block;height:1.125em;margin:0 auto;-webkit-mask-image:var(--md-clipboard-icon);mask-image:var(--md-clipboard-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;width:1.125em}.md-clipboard--inline{cursor:pointer}.md-clipboard--inline code{transition:color .25s,background-color .25s}.md-clipboard--inline:focus code,.md-clipboard--inline:hover code{background-color:var(--md-accent-fg-color--transparent);color:var(--md-accent-fg-color)}.md-content{flex-grow:1;min-width:0}.md-content__inner{margin:0 .8rem 1.2rem;padding-top:.6rem}@media screen and (min-width:76.25em){.md-sidebar--primary:not([hidden])~.md-content>.md-content__inner{margin-left:1.2rem}[dir=rtl] .md-sidebar--primary:not([hidden])~.md-content>.md-content__inner{margin-left:.8rem;margin-right:1.2rem}.md-sidebar--secondary:not([hidden])~.md-content>.md-content__inner{margin-right:1.2rem}[dir=rtl] .md-sidebar--secondary:not([hidden])~.md-content>.md-content__inner{margin-left:1.2rem;margin-right:.8rem}}.md-content__inner:before{content:"";display:block;height:.4rem}.md-content__inner>:last-child{margin-bottom:0}.md-content__button{float:right;margin:.4rem 0 .4rem .4rem;padding:0}@media print{.md-content__button{display:none}}[dir=rtl] .md-content__button{float:left;margin-left:0;margin-right:.4rem}[dir=rtl] .md-content__button svg{transform:scaleX(-1)}.md-typeset .md-content__button{color:var(--md-default-fg-color--lighter)}.md-content__button svg{display:inline;vertical-align:top}.md-dialog{background-color:var(--md-default-fg-color);border-radius:.1rem;bottom:.8rem;box-shadow:0 2px 2px 0 rgba(0,0,0,.14),0 1px 5px 0 rgba(0,0,0,.12),0 3px 1px -2px rgba(0,0,0,.2);left:auto;min-width:11.1rem;opacity:0;padding:.4rem .6rem;pointer-events:none;position:fixed;right:.8rem;transform:translateY(100%);transition:transform 0ms .4s,opacity .4s;z-index:3}@media print{.md-dialog{display:none}}[dir=rtl] .md-dialog{left:.8rem;right:auto}.md-dialog[data-md-state=open]{opacity:1;pointer-events:auto;transform:translateY(0);transition:transform .4s cubic-bezier(.075,.85,.175,1),opacity .4s}.md-dialog__inner{color:var(--md-default-bg-color);font-size:.7rem}.md-typeset .md-button{border:.1rem solid;border-radius:.1rem;color:var(--md-primary-fg-color);display:inline-block;font-weight:700;padding:.625em 2em;transition:color 125ms,background-color 125ms,border-color 125ms}.md-typeset .md-button--primary{background-color:var(--md-primary-fg-color);border-color:var(--md-primary-fg-color);color:var(--md-primary-bg-color)}.md-typeset .md-button:focus,.md-typeset .md-button:hover{background-color:var(--md-accent-fg-color);border-color:var(--md-accent-fg-color);color:var(--md-accent-bg-color)}.md-typeset .md-input{border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.1),0 .025rem .05rem rgba(0,0,0,.1);font-size:.8rem;height:1.8rem;padding:0 .6rem;transition:box-shadow .25s}.md-typeset .md-input:focus,.md-typeset .md-input:hover{box-shadow:0 .4rem 1rem rgba(0,0,0,.15),0 .025rem .05rem rgba(0,0,0,.15)}.md-typeset .md-input--stretch{width:100%}.md-header{background-color:var(--md-primary-fg-color);box-shadow:0 0 .2rem transparent,0 .2rem .4rem transparent;color:var(--md-primary-bg-color);left:0;position:-webkit-sticky;position:sticky;right:0;top:0;z-index:3}@media print{.md-header{display:none}}.md-header[data-md-state=shadow]{box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2);transition:transform .25s cubic-bezier(.1,.7,.1,1),box-shadow .25s}.md-header[data-md-state=hidden]{transform:translateY(-100%);transition:transform .25s cubic-bezier(.8,0,.6,1),box-shadow .25s}.md-header__inner{align-items:center;display:flex;padding:0 .2rem}.md-header__button{color:currentColor;cursor:pointer;margin:.2rem;outline-color:var(--md-accent-fg-color);padding:.4rem;position:relative;transition:opacity .25s;vertical-align:middle;z-index:1}.md-header__button:hover{opacity:.7}.md-header__button:not([hidden]){display:inline-block}.md-header__button:not(.focus-visible){-webkit-tap-highlight-color:transparent;outline:none}.md-header__button.md-logo{margin:.2rem;padding:.4rem}@media screen and (max-width:76.1875em){.md-header__button.md-logo{display:none}}.md-header__button.md-logo img,.md-header__button.md-logo svg{fill:currentColor;display:block;height:1.2rem;width:1.2rem}@media screen and (min-width:60em){.md-header__button[for=__search]{display:none}}.no-js .md-header__button[for=__search]{display:none}[dir=rtl] .md-header__button[for=__search] svg{transform:scaleX(-1)}@media screen and (min-width:76.25em){.md-header__button[for=__drawer]{display:none}}.md-header__topic{display:flex;max-width:100%;position:absolute;transition:transform .4s cubic-bezier(.1,.7,.1,1),opacity .15s}.md-header__topic+.md-header__topic{opacity:0;pointer-events:none;transform:translateX(1.25rem);transition:transform .4s cubic-bezier(1,.7,.1,.1),opacity .15s;z-index:-1}[dir=rtl] .md-header__topic+.md-header__topic{transform:translateX(-1.25rem)}.md-header__title{flex-grow:1;font-size:.9rem;height:2.4rem;line-height:2.4rem;margin-left:1rem;margin-right:.4rem}.md-header__title[data-md-state=active] .md-header__topic{opacity:0;pointer-events:none;transform:translateX(-1.25rem);transition:transform .4s cubic-bezier(1,.7,.1,.1),opacity .15s;z-index:-1}[dir=rtl] .md-header__title[data-md-state=active] .md-header__topic{transform:translateX(1.25rem)}.md-header__title[data-md-state=active] .md-header__topic+.md-header__topic{opacity:1;pointer-events:auto;transform:translateX(0);transition:transform .4s cubic-bezier(.1,.7,.1,1),opacity .15s;z-index:0}.md-header__title>.md-header__ellipsis{height:100%;position:relative;width:100%}.md-header__option{display:flex;flex-shrink:0;max-width:100%;transition:max-width 0ms .25s,opacity .25s .25s;white-space:nowrap}[data-md-toggle=search]:checked~.md-header .md-header__option{max-width:0;opacity:0;transition:max-width 0ms,opacity 0ms}.md-header__source{display:none}@media screen and (min-width:60em){.md-header__source{display:block;margin-left:1rem;max-width:11.7rem;width:11.7rem}[dir=rtl] .md-header__source{margin-left:0;margin-right:1rem}}@media screen and (min-width:76.25em){.md-header__source{margin-left:1.4rem}[dir=rtl] .md-header__source{margin-right:1.4rem}}.md-footer{background-color:var(--md-footer-bg-color);color:var(--md-footer-fg-color)}@media print{.md-footer{display:none}}.md-footer__inner{overflow:auto;padding:.2rem}.md-footer__link{display:flex;outline-color:var(--md-accent-fg-color);padding-bottom:.4rem;padding-top:1.4rem;transition:opacity .25s}@media screen and (min-width:45em){.md-footer__link{width:50%}}.md-footer__link:focus,.md-footer__link:hover{opacity:.7}.md-footer__link--prev{float:left}@media screen and (max-width:44.9375em){.md-footer__link--prev{width:25%}.md-footer__link--prev .md-footer__title{display:none}}[dir=rtl] .md-footer__link--prev{float:right}[dir=rtl] .md-footer__link--prev svg{transform:scaleX(-1)}.md-footer__link--next{float:right;text-align:right}@media screen and (max-width:44.9375em){.md-footer__link--next{width:75%}}[dir=rtl] .md-footer__link--next{float:left;text-align:left}[dir=rtl] .md-footer__link--next svg{transform:scaleX(-1)}.md-footer__title{flex-grow:1;font-size:.9rem;line-height:2.4rem;max-width:calc(100% - 2.4rem);padding:0 1rem;position:relative}.md-footer__button{margin:.2rem;padding:.4rem}.md-footer__direction{font-size:.64rem;left:0;margin-top:-1rem;opacity:.7;padding:0 1rem;position:absolute;right:0}.md-footer-meta{background-color:var(--md-footer-bg-color--dark)}.md-footer-meta__inner{display:flex;flex-wrap:wrap;justify-content:space-between;padding:.2rem}html .md-footer-meta.md-typeset a{color:var(--md-footer-fg-color--light)}html .md-footer-meta.md-typeset a:focus,html .md-footer-meta.md-typeset a:hover{color:var(--md-footer-fg-color)}.md-footer-copyright{color:var(--md-footer-fg-color--lighter);font-size:.64rem;margin:auto .6rem;padding:.4rem 0;width:100%}@media screen and (min-width:45em){.md-footer-copyright{width:auto}}.md-footer-copyright__highlight{color:var(--md-footer-fg-color--light)}.md-footer-social{margin:0 .4rem;padding:.2rem 0 .6rem}@media screen and (min-width:45em){.md-footer-social{padding:.6rem 0}}.md-footer-social__link{display:inline-block;height:1.6rem;text-align:center;width:1.6rem}.md-footer-social__link:before{line-height:1.9}.md-footer-social__link svg{fill:currentColor;max-height:.8rem;vertical-align:-25%}:root{--md-nav-icon--prev:url('data:image/svg+xml;charset=utf-8,');--md-nav-icon--next:url('data:image/svg+xml;charset=utf-8,');--md-toc-icon:url('data:image/svg+xml;charset=utf-8,')}.md-nav{font-size:.7rem;line-height:1.3}.md-nav__title{display:block;font-weight:700;overflow:hidden;padding:0 .6rem;text-overflow:ellipsis}.md-nav__title .md-nav__button{display:none}.md-nav__title .md-nav__button img{height:100%;width:auto}.md-nav__title .md-nav__button.md-logo img,.md-nav__title .md-nav__button.md-logo svg{fill:currentColor;display:block;height:2.4rem;width:2.4rem}.md-nav__list{margin:0;padding:0}.md-nav__item{display:block;padding:0 .6rem}.md-nav__item .md-nav__item{padding-right:0}[dir=rtl] .md-nav__item .md-nav__item{padding-left:0;padding-right:.6rem}.md-nav__link{cursor:pointer;display:block;margin-top:.625em;overflow:hidden;scroll-snap-align:start;text-overflow:ellipsis;transition:color 125ms}.md-nav__link[data-md-state=blur]{color:var(--md-default-fg-color--light)}.md-nav__link--container{display:flex}.md-nav__link--container>:first-child{flex-grow:1}.md-nav__link--container>*{cursor:inherit}.md-nav__item .md-nav__link--active{color:var(--md-typeset-a-color)}.md-nav__link:focus,.md-nav__link:hover{color:var(--md-accent-fg-color)}.md-nav__link.focus-visible{outline-color:var(--md-accent-fg-color);outline-offset:.2rem}.md-nav--primary .md-nav__link[for=__toc]{display:none}.md-nav--primary .md-nav__link[for=__toc] .md-icon:after{background-color:currentColor;display:block;height:100%;-webkit-mask-image:var(--md-toc-icon);mask-image:var(--md-toc-icon);width:100%}.md-nav--primary .md-nav__link[for=__toc]~.md-nav{display:none}.md-nav__source{display:none}@media screen and (max-width:76.1875em){.md-nav--primary,.md-nav--primary .md-nav{background-color:var(--md-default-bg-color);display:flex;flex-direction:column;height:100%;left:0;position:absolute;right:0;top:0;z-index:1}.md-nav--primary .md-nav__item,.md-nav--primary .md-nav__title{font-size:.8rem;line-height:1.5}.md-nav--primary .md-nav__title{background-color:var(--md-default-fg-color--lightest);color:var(--md-default-fg-color--light);cursor:pointer;font-weight:400;height:5.6rem;line-height:2.4rem;padding:3rem .8rem .2rem;position:relative;white-space:nowrap}.md-nav--primary .md-nav__title .md-nav__icon{display:block;height:1.2rem;left:.4rem;margin:.2rem;position:absolute;top:.4rem;width:1.2rem}[dir=rtl] .md-nav--primary .md-nav__title .md-nav__icon{left:auto;right:.4rem}.md-nav--primary .md-nav__title .md-nav__icon:after{background-color:currentColor;content:"";display:block;height:100%;-webkit-mask-image:var(--md-nav-icon--prev);mask-image:var(--md-nav-icon--prev);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;width:100%}.md-nav--primary .md-nav__title~.md-nav__list{background-color:var(--md-default-bg-color);box-shadow:0 .05rem 0 var(--md-default-fg-color--lightest) inset;overflow-y:auto;-ms-scroll-snap-type:y mandatory;scroll-snap-type:y mandatory;touch-action:pan-y}.md-nav--primary .md-nav__title~.md-nav__list>:first-child{border-top:0}.md-nav--primary .md-nav__title[for=__drawer]{background-color:var(--md-primary-fg-color);color:var(--md-primary-bg-color)}.md-nav--primary .md-nav__title .md-logo{display:block;left:.2rem;margin:.2rem;padding:.4rem;position:absolute;top:.2rem}[dir=rtl] .md-nav--primary .md-nav__title .md-logo{left:auto;right:.2rem}.md-nav--primary .md-nav__list{flex:1}.md-nav--primary .md-nav__item{border-top:.05rem solid var(--md-default-fg-color--lightest);padding:0}.md-nav--primary .md-nav__item--nested>.md-nav__link{padding-right:2.4rem}[dir=rtl] .md-nav--primary .md-nav__item--nested>.md-nav__link{padding-left:2.4rem;padding-right:.8rem}.md-nav--primary .md-nav__item--active>.md-nav__link{color:var(--md-typeset-a-color)}.md-nav--primary .md-nav__item--active>.md-nav__link:focus,.md-nav--primary .md-nav__item--active>.md-nav__link:hover{color:var(--md-accent-fg-color)}.md-nav--primary .md-nav__link{margin-top:0;padding:.6rem .8rem;position:relative}.md-nav--primary .md-nav__link .md-nav__icon{color:inherit;font-size:1.2rem;height:1.2rem;margin-top:-.6rem;position:absolute;right:.6rem;top:50%;width:1.2rem}[dir=rtl] .md-nav--primary .md-nav__link .md-nav__icon{left:.6rem;right:auto}.md-nav--primary .md-nav__link .md-nav__icon:after{background-color:currentColor;content:"";display:block;height:100%;-webkit-mask-image:var(--md-nav-icon--next);mask-image:var(--md-nav-icon--next);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;width:100%}[dir=rtl] .md-nav--primary .md-nav__icon:after{transform:scale(-1)}.md-nav--primary .md-nav--secondary .md-nav__link{position:static}.md-nav--primary .md-nav--secondary .md-nav{background-color:transparent;position:static}.md-nav--primary .md-nav--secondary .md-nav .md-nav__link{padding-left:1.4rem}[dir=rtl] .md-nav--primary .md-nav--secondary .md-nav .md-nav__link{padding-left:0;padding-right:1.4rem}.md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav__link{padding-left:2rem}[dir=rtl] .md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav__link{padding-left:0;padding-right:2rem}.md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav .md-nav__link{padding-left:2.6rem}[dir=rtl] .md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav .md-nav__link{padding-left:0;padding-right:2.6rem}.md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav .md-nav .md-nav__link{padding-left:3.2rem}[dir=rtl] .md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav .md-nav .md-nav__link{padding-left:0;padding-right:3.2rem}.md-nav--secondary{background-color:transparent}.md-nav__toggle~.md-nav{display:flex;opacity:0;transform:translateX(100%);transition:transform .25s cubic-bezier(.8,0,.6,1),opacity 125ms 50ms}[dir=rtl] .md-nav__toggle~.md-nav{transform:translateX(-100%)}.md-nav__toggle:checked~.md-nav{opacity:1;transform:translateX(0);transition:transform .25s cubic-bezier(.4,0,.2,1),opacity 125ms 125ms}.md-nav__toggle:checked~.md-nav>.md-nav__list{-webkit-backface-visibility:hidden;backface-visibility:hidden}}@media screen and (max-width:59.9375em){.md-nav--primary .md-nav__link[for=__toc]{display:block;padding-right:2.4rem}[dir=rtl] .md-nav--primary .md-nav__link[for=__toc]{padding-left:2.4rem;padding-right:.8rem}.md-nav--primary .md-nav__link[for=__toc] .md-icon:after{content:""}.md-nav--primary .md-nav__link[for=__toc]+.md-nav__link{display:none}.md-nav--primary .md-nav__link[for=__toc]~.md-nav{display:flex}.md-nav__source{background-color:var(--md-primary-fg-color--dark);color:var(--md-primary-bg-color);display:block;padding:0 .2rem}}@media screen and (min-width:60em) and (max-width:76.1875em){.md-nav--integrated .md-nav__link[for=__toc]{display:block;padding-right:2.4rem;scroll-snap-align:none}[dir=rtl] .md-nav--integrated .md-nav__link[for=__toc]{padding-left:2.4rem;padding-right:.8rem}.md-nav--integrated .md-nav__link[for=__toc] .md-icon:after{content:""}.md-nav--integrated .md-nav__link[for=__toc]+.md-nav__link{display:none}.md-nav--integrated .md-nav__link[for=__toc]~.md-nav{display:flex}}@media screen and (min-width:60em){.md-nav--secondary .md-nav__title{background:var(--md-default-bg-color);box-shadow:0 0 .4rem .4rem var(--md-default-bg-color);position:-webkit-sticky;position:sticky;top:0}.md-nav--secondary .md-nav__title[for=__toc]{scroll-snap-align:start}.md-nav--secondary .md-nav__title .md-nav__icon{display:none}}@media screen and (min-width:76.25em){.md-nav{transition:max-height .25s cubic-bezier(.86,0,.07,1)}.md-nav--primary .md-nav__title{background:var(--md-default-bg-color);box-shadow:0 0 .4rem .4rem var(--md-default-bg-color);position:-webkit-sticky;position:sticky;top:0}.md-nav--primary .md-nav__title[for=__drawer]{scroll-snap-align:start}.md-nav--primary .md-nav__title .md-nav__icon{display:none}.md-nav__toggle~.md-nav{display:none}.md-nav__toggle:checked~.md-nav,.md-nav__toggle:indeterminate~.md-nav{display:block}.md-nav__item--nested>.md-nav>.md-nav__title{display:none}.md-nav__item--section{display:block;margin:1.25em 0}.md-nav__item--section:last-child{margin-bottom:0}.md-nav__item--section>.md-nav__link{font-weight:700;pointer-events:none}.md-nav__item--section>.md-nav__link>*{pointer-events:auto}.md-nav__item--section>.md-nav__link .md-icon{display:none}.md-nav__item--section>.md-nav{display:block}.md-nav__item--section>.md-nav>.md-nav__list>.md-nav__item{padding:0}.md-nav__icon{float:right;height:.9rem;transition:transform .25s;width:.9rem}[dir=rtl] .md-nav__icon{float:left;transform:rotate(180deg)}.md-nav__icon:after{background-color:currentColor;content:"";display:inline-block;height:100%;-webkit-mask-image:var(--md-nav-icon--next);mask-image:var(--md-nav-icon--next);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;vertical-align:-.1rem;width:100%}.md-nav__item--nested .md-nav__toggle:checked~.md-nav__link .md-nav__icon,.md-nav__item--nested .md-nav__toggle:indeterminate~.md-nav__link .md-nav__icon{transform:rotate(90deg)}.md-nav--lifted>.md-nav__list>.md-nav__item--nested,.md-nav--lifted>.md-nav__title{display:none}.md-nav--lifted>.md-nav__list>.md-nav__item{display:none}.md-nav--lifted>.md-nav__list>.md-nav__item--active{display:block;padding:0}.md-nav--lifted>.md-nav__list>.md-nav__item--active>.md-nav__link{display:none}.md-nav--lifted>.md-nav__list>.md-nav__item--active>.md-nav>.md-nav__title{display:block;padding:0 .6rem;pointer-events:none;scroll-snap-align:start}.md-nav--lifted .md-nav[data-md-level="1"]{display:block}.md-nav--lifted .md-nav[data-md-level="1"]>.md-nav__list>.md-nav__item{padding-right:.6rem}.md-nav--integrated .md-nav__link[for=__toc]~.md-nav{border-left:.05rem solid var(--md-primary-fg-color);display:block;margin-bottom:1.25em}.md-nav--integrated .md-nav__link[for=__toc]~.md-nav>.md-nav__title{display:none}}:root{--md-search-result-icon:url('data:image/svg+xml;charset=utf-8,')}.md-search{position:relative}@media screen and (min-width:60em){.md-search{padding:.2rem 0}}.no-js .md-search{display:none}.md-search__overlay{opacity:0;z-index:1}@media screen and (max-width:59.9375em){.md-search__overlay{background-color:var(--md-default-bg-color);border-radius:1rem;height:2rem;left:-2.2rem;overflow:hidden;pointer-events:none;position:absolute;top:.2rem;transform-origin:center;transition:transform .3s .1s,opacity .2s .2s;width:2rem}[dir=rtl] .md-search__overlay{left:auto;right:-2.2rem}[data-md-toggle=search]:checked~.md-header .md-search__overlay{opacity:1;transition:transform .4s,opacity .1s}}@media screen and (min-width:60em){.md-search__overlay{background-color:rgba(0,0,0,.54);cursor:pointer;height:0;left:0;position:fixed;top:0;transition:width 0ms .25s,height 0ms .25s,opacity .25s;width:0}[dir=rtl] .md-search__overlay{left:auto;right:0}[data-md-toggle=search]:checked~.md-header .md-search__overlay{height:200vh;opacity:1;transition:width 0ms,height 0ms,opacity .25s;width:100%}}@media screen and (max-width:29.9375em){[data-md-toggle=search]:checked~.md-header .md-search__overlay{transform:scale(45)}}@media screen and (min-width:30em) and (max-width:44.9375em){[data-md-toggle=search]:checked~.md-header .md-search__overlay{transform:scale(60)}}@media screen and (min-width:45em) and (max-width:59.9375em){[data-md-toggle=search]:checked~.md-header .md-search__overlay{transform:scale(75)}}.md-search__inner{-webkit-backface-visibility:hidden;backface-visibility:hidden}@media screen and (max-width:59.9375em){.md-search__inner{height:100%;left:100%;opacity:0;position:fixed;top:0;transform:translateX(5%);transition:right 0ms .3s,left 0ms .3s,transform .15s cubic-bezier(.4,0,.2,1) .15s,opacity .15s .15s;width:100%;z-index:2}[data-md-toggle=search]:checked~.md-header .md-search__inner{left:0;opacity:1;transform:translateX(0);transition:right 0ms 0ms,left 0ms 0ms,transform .15s cubic-bezier(.1,.7,.1,1) .15s,opacity .15s .15s}[dir=rtl] [data-md-toggle=search]:checked~.md-header .md-search__inner{left:auto;right:0}html [dir=rtl] .md-search__inner{left:auto;right:100%;transform:translateX(-5%)}}@media screen and (min-width:60em){.md-search__inner{float:right;padding:.1rem 0;position:relative;transition:width .25s cubic-bezier(.1,.7,.1,1);width:11.7rem}[dir=rtl] .md-search__inner{float:left}}@media screen and (min-width:60em) and (max-width:76.1875em){[data-md-toggle=search]:checked~.md-header .md-search__inner{width:23.4rem}}@media screen and (min-width:76.25em){[data-md-toggle=search]:checked~.md-header .md-search__inner{width:34.4rem}}.md-search__form{background-color:var(--md-default-bg-color);box-shadow:0 0 .6rem transparent;height:2.4rem;position:relative;transition:color .25s,background-color .25s;z-index:2}@media screen and (min-width:60em){.md-search__form{background-color:rgba(0,0,0,.26);border-radius:.1rem;height:1.8rem}.md-search__form:hover{background-color:hsla(0,0%,100%,.12)}}[data-md-toggle=search]:checked~.md-header .md-search__form{background-color:var(--md-default-bg-color);border-radius:.1rem .1rem 0 0;box-shadow:0 0 .6rem rgba(0,0,0,.07);color:var(--md-default-fg-color)}.md-search__input{background:transparent;font-size:.9rem;height:100%;padding:0 2.2rem 0 3.6rem;position:relative;text-overflow:ellipsis;width:100%;z-index:2}[dir=rtl] .md-search__input{padding:0 3.6rem 0 2.2rem}.md-search__input::-webkit-input-placeholder{-webkit-transition:color .25s;transition:color .25s}.md-search__input::-moz-placeholder{-moz-transition:color .25s;transition:color .25s}.md-search__input::-ms-input-placeholder{-ms-transition:color .25s;transition:color .25s}.md-search__input::placeholder{transition:color .25s}.md-search__input::-webkit-input-placeholder{color:var(--md-default-fg-color--light)}.md-search__input::-moz-placeholder{color:var(--md-default-fg-color--light)}.md-search__input::-ms-input-placeholder{color:var(--md-default-fg-color--light)}.md-search__input::placeholder,.md-search__input~.md-search__icon{color:var(--md-default-fg-color--light)}.md-search__input::-ms-clear{display:none}@media screen and (max-width:59.9375em){.md-search__input{font-size:.9rem;height:2.4rem;width:100%}}@media screen and (min-width:60em){.md-search__input{color:inherit;font-size:.8rem;padding-left:2.2rem}[dir=rtl] .md-search__input{padding-right:2.2rem}.md-search__input::-webkit-input-placeholder{color:var(--md-primary-bg-color--light)}.md-search__input::-moz-placeholder{color:var(--md-primary-bg-color--light)}.md-search__input::-ms-input-placeholder{color:var(--md-primary-bg-color--light)}.md-search__input::placeholder{color:var(--md-primary-bg-color--light)}.md-search__input+.md-search__icon{color:var(--md-primary-bg-color)}[data-md-toggle=search]:checked~.md-header .md-search__input{text-overflow:clip}[data-md-toggle=search]:checked~.md-header .md-search__input::-webkit-input-placeholder{color:var(--md-default-fg-color--light)}[data-md-toggle=search]:checked~.md-header .md-search__input::-moz-placeholder{color:var(--md-default-fg-color--light)}[data-md-toggle=search]:checked~.md-header .md-search__input::-ms-input-placeholder{color:var(--md-default-fg-color--light)}[data-md-toggle=search]:checked~.md-header .md-search__input+.md-search__icon,[data-md-toggle=search]:checked~.md-header .md-search__input::placeholder{color:var(--md-default-fg-color--light)}}.md-search__icon{cursor:pointer;display:inline-block;height:1.2rem;transition:color .25s,opacity .25s;width:1.2rem}.md-search__icon:hover{opacity:.7}.md-search__icon[for=__search]{left:.5rem;position:absolute;top:.3rem;z-index:2}[dir=rtl] .md-search__icon[for=__search]{left:auto;right:.5rem}[dir=rtl] .md-search__icon[for=__search] svg{transform:scaleX(-1)}@media screen and (max-width:59.9375em){.md-search__icon[for=__search]{left:.8rem;top:.6rem}[dir=rtl] .md-search__icon[for=__search]{left:auto;right:.8rem}.md-search__icon[for=__search] svg:first-child{display:none}}@media screen and (min-width:60em){.md-search__icon[for=__search]{pointer-events:none}.md-search__icon[for=__search] svg:last-child{display:none}}.md-search__options{pointer-events:none;position:absolute;right:.5rem;top:.3rem;z-index:2}[dir=rtl] .md-search__options{left:.5rem;right:auto}@media screen and (max-width:59.9375em){.md-search__options{right:.8rem;top:.6rem}[dir=rtl] .md-search__options{left:.8rem;right:auto}}.md-search__options>*{color:var(--md-default-fg-color--light);margin-left:.2rem;opacity:0;transform:scale(.75);transition:transform .15s cubic-bezier(.1,.7,.1,1),opacity .15s}.md-search__options>:not(.focus-visible){-webkit-tap-highlight-color:transparent;outline:none}[data-md-toggle=search]:checked~.md-header .md-search__input:valid~.md-search__options>*{opacity:1;pointer-events:auto;transform:scale(1)}[data-md-toggle=search]:checked~.md-header .md-search__input:valid~.md-search__options>:hover{opacity:.7}.md-search__suggest{align-items:center;color:var(--md-default-fg-color--lighter);display:flex;font-size:.9rem;height:100%;opacity:0;padding:0 2.2rem 0 3.6rem;position:absolute;top:0;transition:opacity 50ms;white-space:nowrap;width:100%}[dir=rtl] .md-search__suggest{padding:0 3.6rem 0 2.2rem}@media screen and (min-width:60em){.md-search__suggest{font-size:.8rem;padding-left:2.2rem}[dir=rtl] .md-search__suggest{padding-right:2.2rem}}[data-md-toggle=search]:checked~.md-header .md-search__suggest{opacity:1;transition:opacity .3s .1s}.md-search__output{border-radius:0 0 .1rem .1rem;overflow:hidden;position:absolute;width:100%;z-index:1}@media screen and (max-width:59.9375em){.md-search__output{bottom:0;top:2.4rem}}@media screen and (min-width:60em){.md-search__output{opacity:0;top:1.9rem;transition:opacity .4s}[data-md-toggle=search]:checked~.md-header .md-search__output{box-shadow:0 6px 10px 0 rgba(0,0,0,.14),0 1px 18px 0 rgba(0,0,0,.12),0 3px 5px -1px rgba(0,0,0,.4);opacity:1}}.md-search__scrollwrap{-webkit-backface-visibility:hidden;backface-visibility:hidden;background-color:var(--md-default-bg-color);height:100%;overflow-y:auto;touch-action:pan-y}@media (-webkit-max-device-pixel-ratio:1),(max-resolution:1dppx){.md-search__scrollwrap{transform:translateZ(0)}}@media screen and (min-width:60em) and (max-width:76.1875em){.md-search__scrollwrap{width:23.4rem}}@media screen and (min-width:76.25em){.md-search__scrollwrap{width:34.4rem}}@media screen and (min-width:60em){.md-search__scrollwrap{max-height:0;scrollbar-color:var(--md-default-fg-color--lighter) transparent;scrollbar-width:thin}[data-md-toggle=search]:checked~.md-header .md-search__scrollwrap{max-height:75vh}.md-search__scrollwrap:hover{scrollbar-color:var(--md-accent-fg-color) transparent}.md-search__scrollwrap::-webkit-scrollbar{height:.2rem;width:.2rem}.md-search__scrollwrap::-webkit-scrollbar-thumb{background-color:var(--md-default-fg-color--lighter)}.md-search__scrollwrap::-webkit-scrollbar-thumb:hover{background-color:var(--md-accent-fg-color)}}.md-search-result{color:var(--md-default-fg-color);word-break:break-word}.md-search-result__meta{background-color:var(--md-default-fg-color--lightest);color:var(--md-default-fg-color--light);font-size:.64rem;line-height:1.8rem;padding:0 .8rem;scroll-snap-align:start}@media screen and (min-width:60em){.md-search-result__meta{padding-left:2.2rem}[dir=rtl] .md-search-result__meta{padding-left:0;padding-right:2.2rem}}.md-search-result__list{list-style:none;margin:0;padding:0}.md-search-result__item{box-shadow:0 -.05rem 0 var(--md-default-fg-color--lightest)}.md-search-result__item:first-child{box-shadow:none}.md-search-result__link{display:block;outline:none;scroll-snap-align:start;transition:background-color .25s}.md-search-result__link:focus,.md-search-result__link:hover{background-color:var(--md-accent-fg-color--transparent)}.md-search-result__link:last-child p:last-child{margin-bottom:.6rem}.md-search-result__more summary{color:var(--md-typeset-a-color);cursor:pointer;display:block;font-size:.64rem;outline:none;padding:.75em .8rem;scroll-snap-align:start;transition:color .25s,background-color .25s}@media screen and (min-width:60em){.md-search-result__more summary{padding-left:2.2rem}[dir=rtl] .md-search-result__more summary{padding-left:.8rem;padding-right:2.2rem}}.md-search-result__more summary:focus,.md-search-result__more summary:hover{background-color:var(--md-accent-fg-color--transparent);color:var(--md-accent-fg-color)}.md-search-result__more summary::-webkit-details-marker,.md-search-result__more summary::marker{display:none}.md-search-result__more summary~*>*{opacity:.65}.md-search-result__article{overflow:hidden;padding:0 .8rem;position:relative}@media screen and (min-width:60em){.md-search-result__article{padding-left:2.2rem}[dir=rtl] .md-search-result__article{padding-left:.8rem;padding-right:2.2rem}}.md-search-result__article--document .md-search-result__title{font-size:.8rem;font-weight:400;line-height:1.4;margin:.55rem 0}.md-search-result__icon{color:var(--md-default-fg-color--light);height:1.2rem;left:0;margin:.5rem;position:absolute;width:1.2rem}@media screen and (max-width:59.9375em){.md-search-result__icon{display:none}}.md-search-result__icon:after{background-color:currentColor;content:"";display:inline-block;height:100%;-webkit-mask-image:var(--md-search-result-icon);mask-image:var(--md-search-result-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;width:100%}[dir=rtl] .md-search-result__icon{left:auto;right:0}[dir=rtl] .md-search-result__icon:after{transform:scaleX(-1)}.md-search-result__title{font-size:.64rem;font-weight:700;line-height:1.6;margin:.5em 0}.md-search-result__teaser{-webkit-box-orient:vertical;-webkit-line-clamp:2;color:var(--md-default-fg-color--light);display:-webkit-box;font-size:.64rem;line-height:1.6;margin:.5em 0;max-height:2rem;overflow:hidden;text-overflow:ellipsis}@media screen and (max-width:44.9375em){.md-search-result__teaser{-webkit-line-clamp:3;max-height:3rem}}@media screen and (min-width:60em) and (max-width:76.1875em){.md-search-result__teaser{-webkit-line-clamp:3;max-height:3rem}}.md-search-result__teaser mark{background-color:transparent;text-decoration:underline}.md-search-result__terms{font-size:.64rem;font-style:italic;margin:.5em 0}.md-search-result mark{background-color:transparent;color:var(--md-accent-fg-color)}.md-select{position:relative;z-index:1}.md-select__inner{background-color:var(--md-default-bg-color);border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.1),0 0 .05rem rgba(0,0,0,.25);color:var(--md-default-fg-color);left:50%;margin-top:.2rem;max-height:0;opacity:0;position:absolute;top:calc(100% - .2rem);transform:translate3d(-50%,.3rem,0);transition:transform .25s 375ms,opacity .25s .25s,max-height 0ms .5s}.md-select:focus-within .md-select__inner,.md-select:hover .md-select__inner{max-height:10rem;opacity:1;transform:translate3d(-50%,0,0);transition:transform .25s cubic-bezier(.1,.7,.1,1),opacity .25s,max-height 0ms}.md-select__inner:after{border-bottom:.2rem solid transparent;border-bottom-color:var(--md-default-bg-color);border-left:.2rem solid transparent;border-right:.2rem solid transparent;border-top:0;content:"";height:0;left:50%;margin-left:-.2rem;margin-top:-.2rem;position:absolute;top:0;width:0}.md-select__list{border-radius:.1rem;font-size:.8rem;list-style-type:none;margin:0;max-height:inherit;overflow:auto;padding:0}.md-select__item{line-height:1.8rem}.md-select__link{cursor:pointer;display:block;outline:none;padding-left:.6rem;padding-right:1.2rem;scroll-snap-align:start;transition:background-color .25s,color .25s;width:100%}[dir=rtl] .md-select__link{padding-left:1.2rem;padding-right:.6rem}.md-select__link:focus,.md-select__link:hover{color:var(--md-accent-fg-color)}.md-select__link:focus{background-color:var(--md-default-fg-color--lightest)}.md-sidebar{align-self:flex-start;flex-shrink:0;padding:1.2rem 0;position:-webkit-sticky;position:sticky;top:2.4rem;width:12.1rem}@media print{.md-sidebar{display:none}}@media screen and (max-width:76.1875em){.md-sidebar--primary{background-color:var(--md-default-bg-color);display:block;height:100%;left:-12.1rem;position:fixed;top:0;transform:translateX(0);transition:transform .25s cubic-bezier(.4,0,.2,1),box-shadow .25s;width:12.1rem;z-index:4}[dir=rtl] .md-sidebar--primary{left:auto;right:-12.1rem}[data-md-toggle=drawer]:checked~.md-container .md-sidebar--primary{box-shadow:0 8px 10px 1px rgba(0,0,0,.14),0 3px 14px 2px rgba(0,0,0,.12),0 5px 5px -3px rgba(0,0,0,.4);transform:translateX(12.1rem)}[dir=rtl] [data-md-toggle=drawer]:checked~.md-container .md-sidebar--primary{transform:translateX(-12.1rem)}.md-sidebar--primary .md-sidebar__scrollwrap{bottom:0;left:0;margin:0;overflow:hidden;position:absolute;right:0;-ms-scroll-snap-type:none;scroll-snap-type:none;top:0}}@media screen and (min-width:76.25em){.md-sidebar{height:0}.no-js .md-sidebar{height:auto}}.md-sidebar--secondary{display:none;order:2}@media screen and (min-width:60em){.md-sidebar--secondary{height:0}.no-js .md-sidebar--secondary{height:auto}.md-sidebar--secondary:not([hidden]){display:block}.md-sidebar--secondary .md-sidebar__scrollwrap{touch-action:pan-y}}.md-sidebar__scrollwrap{-webkit-backface-visibility:hidden;backface-visibility:hidden;margin:0 .2rem;overflow-y:auto;scrollbar-color:var(--md-default-fg-color--lighter) transparent;scrollbar-width:thin}.md-sidebar__scrollwrap:hover{scrollbar-color:var(--md-accent-fg-color) transparent}.md-sidebar__scrollwrap::-webkit-scrollbar{height:.2rem;width:.2rem}.md-sidebar__scrollwrap::-webkit-scrollbar-thumb{background-color:var(--md-default-fg-color--lighter)}.md-sidebar__scrollwrap::-webkit-scrollbar-thumb:hover{background-color:var(--md-accent-fg-color)}@media screen and (max-width:76.1875em){.md-overlay{background-color:rgba(0,0,0,.54);height:0;opacity:0;position:fixed;top:0;transition:width 0ms .25s,height 0ms .25s,opacity .25s;width:0;z-index:4}[data-md-toggle=drawer]:checked~.md-overlay{height:100%;opacity:1;transition:width 0ms,height 0ms,opacity .25s;width:100%}}@-webkit-keyframes facts{0%{height:0}to{height:.65rem}}@keyframes facts{0%{height:0}to{height:.65rem}}@-webkit-keyframes fact{0%{opacity:0;transform:translateY(100%)}50%{opacity:0}to{opacity:1;transform:translateY(0)}}@keyframes fact{0%{opacity:0;transform:translateY(100%)}50%{opacity:0}to{opacity:1;transform:translateY(0)}}:root{--md-source-forks-icon:url('data:image/svg+xml;charset=utf-8,');--md-source-repositories-icon:url('data:image/svg+xml;charset=utf-8,');--md-source-stars-icon:url('data:image/svg+xml;charset=utf-8,');--md-source-version-icon:url('data:image/svg+xml;charset=utf-8,')}.md-source{-webkit-backface-visibility:hidden;backface-visibility:hidden;display:block;font-size:.65rem;line-height:1.2;outline-color:var(--md-accent-fg-color);transition:opacity .25s;white-space:nowrap}.md-source:hover{opacity:.7}.md-source__icon{display:inline-block;height:2.4rem;vertical-align:middle;width:2rem}.md-source__icon svg{margin-left:.6rem;margin-top:.6rem}[dir=rtl] .md-source__icon svg{margin-left:0;margin-right:.6rem}.md-source__icon+.md-source__repository{margin-left:-2rem;padding-left:2rem}[dir=rtl] .md-source__icon+.md-source__repository{margin-left:0;margin-right:-2rem;padding-left:0;padding-right:2rem}.md-source__repository{display:inline-block;margin-left:.6rem;max-width:calc(100% - 1.2rem);overflow:hidden;text-overflow:ellipsis;vertical-align:middle}.md-source__facts{font-size:.55rem;list-style-type:none;margin:.1rem 0 0;opacity:.75;overflow:hidden;padding:0}[data-md-state=done] .md-source__facts{-webkit-animation:facts .25s ease-in;animation:facts .25s ease-in}.md-source__fact{display:inline-block}[data-md-state=done] .md-source__fact{-webkit-animation:fact .4s ease-out;animation:fact .4s ease-out}.md-source__fact:before{background-color:currentColor;content:"";display:inline-block;height:.6rem;margin-right:.1rem;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;vertical-align:text-top;width:.6rem}.md-source__fact:nth-child(1n+2):before{margin-left:.4rem}[dir=rtl] .md-source__fact{margin-left:.1rem;margin-right:0}[dir=rtl] .md-source__fact:nth-child(1n+2):before{margin-left:0;margin-right:.4rem}.md-source__fact--version:before{-webkit-mask-image:var(--md-source-version-icon);mask-image:var(--md-source-version-icon)}.md-source__fact--stars:before{-webkit-mask-image:var(--md-source-stars-icon);mask-image:var(--md-source-stars-icon)}.md-source__fact--forks:before{-webkit-mask-image:var(--md-source-forks-icon);mask-image:var(--md-source-forks-icon)}.md-source__fact--repositories:before{-webkit-mask-image:var(--md-source-repositories-icon);mask-image:var(--md-source-repositories-icon)}.md-tabs{background-color:var(--md-primary-fg-color);color:var(--md-primary-bg-color);overflow:auto;width:100%}@media print{.md-tabs{display:none}}@media screen and (max-width:76.1875em){.md-tabs{display:none}}.md-tabs[data-md-state=hidden]{pointer-events:none}.md-tabs__list{contain:content;list-style:none;margin:0 0 0 .2rem;padding:0;white-space:nowrap}[dir=rtl] .md-tabs__list{margin-left:0;margin-right:.2rem}.md-tabs__item{display:inline-block;height:2.4rem;padding-left:.6rem;padding-right:.6rem}.md-tabs__link{-webkit-backface-visibility:hidden;backface-visibility:hidden;display:block;font-size:.7rem;margin-top:.8rem;opacity:.7;outline-color:var(--md-accent-fg-color);outline-offset:.2rem;transition:transform .4s cubic-bezier(.1,.7,.1,1),opacity .25s}.md-tabs__link--active,.md-tabs__link:focus,.md-tabs__link:hover{color:inherit;opacity:1}.md-tabs__item:nth-child(2) .md-tabs__link{transition-delay:20ms}.md-tabs__item:nth-child(3) .md-tabs__link{transition-delay:40ms}.md-tabs__item:nth-child(4) .md-tabs__link{transition-delay:60ms}.md-tabs__item:nth-child(5) .md-tabs__link{transition-delay:80ms}.md-tabs__item:nth-child(6) .md-tabs__link{transition-delay:.1s}.md-tabs__item:nth-child(7) .md-tabs__link{transition-delay:.12s}.md-tabs__item:nth-child(8) .md-tabs__link{transition-delay:.14s}.md-tabs__item:nth-child(9) .md-tabs__link{transition-delay:.16s}.md-tabs__item:nth-child(10) .md-tabs__link{transition-delay:.18s}.md-tabs__item:nth-child(11) .md-tabs__link{transition-delay:.2s}.md-tabs__item:nth-child(12) .md-tabs__link{transition-delay:.22s}.md-tabs__item:nth-child(13) .md-tabs__link{transition-delay:.24s}.md-tabs__item:nth-child(14) .md-tabs__link{transition-delay:.26s}.md-tabs__item:nth-child(15) .md-tabs__link{transition-delay:.28s}.md-tabs__item:nth-child(16) .md-tabs__link{transition-delay:.3s}.md-tabs[data-md-state=hidden] .md-tabs__link{opacity:0;transform:translateY(50%);transition:transform 0ms .1s,opacity .1s}.md-tags{margin-bottom:.75em}.md-tag{background:var(--md-default-fg-color--lightest);border-radius:.4rem;display:inline-block;font-size:.64rem;font-weight:700;line-height:1.6;margin-bottom:.5em;margin-right:.5em;padding:.3125em .9375em}.md-tag[href]{-webkit-tap-highlight-color:transparent;color:inherit;outline:none;transition:color 125ms,background-color 125ms}.md-tag[href]:focus,.md-tag[href]:hover{background-color:var(--md-accent-fg-color);color:var(--md-accent-bg-color)}[id]>.md-tag{vertical-align:text-top}@-webkit-keyframes md-annotation--pulse{0%{box-shadow:0 0 0 0 var(--md-default-fg-color--lightest)}75%{box-shadow:0 0 0 .625em transparent}to{box-shadow:0 0 0 0 transparent}}@keyframes md-annotation--pulse{0%{box-shadow:0 0 0 0 var(--md-default-fg-color--lightest)}75%{box-shadow:0 0 0 .625em transparent}to{box-shadow:0 0 0 0 transparent}}.md-tooltip{-webkit-backface-visibility:hidden;backface-visibility:hidden;background-color:var(--md-default-bg-color);border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.1),0 0 .05rem rgba(0,0,0,.25);color:var(--md-default-fg-color);max-height:0;opacity:0;overflow:auto;position:absolute;transform:translateY(.4rem);transition:transform .25s 375ms,opacity .25s,max-height 0ms .25s,z-index .25s;z-index:0}.md-tooltip__inner{font-size:.64rem;padding:.8rem}.md-tooltip__inner>:first-child{margin-top:0}.md-tooltip__inner>:last-child{margin-bottom:0}:focus-within>.md-tooltip,:focus>.md-tooltip{max-height:1000%;opacity:1;transform:translateY(0);transition:transform .25s cubic-bezier(.1,.7,.1,1),opacity .25s,max-height .25s 0ms,z-index 0ms}:focus-within>.md-tooltip--end,:focus>.md-tooltip--end{transform:translate(-100%)}:focus-within>.md-tooltip--center,:focus>.md-tooltip--center{transform:translate(-50%)}.focus-visible>.md-tooltip{outline:var(--md-accent-fg-color) auto}.md-tooltip--end{transform:translate(-100%,.4rem)}.md-tooltip--center{transform:translate(-50%,.4rem)}.md-annotation{outline:none;white-space:normal}.md-annotation:focus-within>*{z-index:2}.md-annotation:not([hidden]){display:inline-block}.md-annotation__index{-webkit-animation:md-annotation--pulse 2s infinite;animation:md-annotation--pulse 2s infinite;background-color:var(--md-default-fg-color--lighter);border-radius:1.25em;color:var(--md-accent-bg-color);cursor:pointer;display:inline-block;min-width:1.4em;padding:0 .375em;position:relative;text-align:center;transition:background-color .25s,z-index .25s;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;z-index:0}:focus-within>.md-annotation__index{-webkit-animation:none;animation:none;transition:background-color .25s,z-index 0ms}:focus-within>.md-annotation__index,:hover>.md-annotation__index{background-color:var(--md-accent-fg-color)}.md-annotation .md-tooltip{margin:-1.1764705882em .7352941176em 0;max-width:60%;min-width:16rem}.md-annotation .md-tooltip--center{margin-top:.7352941176em}.md-top{background:var(--md-primary-fg-color);border-radius:100%;bottom:.4rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.1),0 .025rem .05rem rgba(0,0,0,.1);color:var(--md-primary-bg-color);float:right;margin:-2.8rem .4rem .4rem;outline:none;padding:.4rem;position:-webkit-sticky;position:sticky;transform:translateY(0);transition:opacity 125ms,transform 125ms cubic-bezier(.4,0,.2,1),background-color 125ms;z-index:1}[dir=rtl] .md-top{float:left}.md-top[data-md-state=hidden]{opacity:0;pointer-events:none;transform:translateY(-.2rem)}.md-top:focus,.md-top:hover{background:var(--md-accent-fg-color);transform:scale(1.1)}@-webkit-keyframes hoverfix{0%{pointer-events:none}}@keyframes hoverfix{0%{pointer-events:none}}:root{--md-version-icon:url('data:image/svg+xml;charset=utf-8,')}.md-version{flex-shrink:0;font-size:.8rem;height:2.4rem}.md-version__current{color:inherit;cursor:pointer;margin-left:1.4rem;margin-right:.4rem;outline:none;position:relative;top:.05rem}[dir=rtl] .md-version__current{margin-left:.4rem;margin-right:1.4rem}.md-version__current:after{background-color:currentColor;content:"";display:inline-block;height:.6rem;margin-left:.4rem;-webkit-mask-image:var(--md-version-icon);mask-image:var(--md-version-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;width:.4rem}[dir=rtl] .md-version__current:after{margin-left:0;margin-right:.4rem}.md-version__list{background-color:var(--md-default-bg-color);border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.1),0 0 .05rem rgba(0,0,0,.25);color:var(--md-default-fg-color);list-style-type:none;margin:.2rem .8rem;max-height:0;opacity:0;overflow:auto;padding:0;position:absolute;-ms-scroll-snap-type:y mandatory;scroll-snap-type:y mandatory;top:.15rem;transition:max-height 0ms .5s,opacity .25s .25s;z-index:1}.md-version:focus-within .md-version__list,.md-version:hover .md-version__list{max-height:10rem;opacity:1;transition:max-height 0ms,opacity .25s}@media (pointer:coarse){.md-version:hover .md-version__list{-webkit-animation:hoverfix .25s forwards;animation:hoverfix .25s forwards}.md-version:focus-within .md-version__list{-webkit-animation:none;animation:none}}.md-version__item{line-height:1.8rem}.md-version__link{cursor:pointer;display:block;outline:none;padding-left:.6rem;padding-right:1.2rem;scroll-snap-align:start;transition:color .25s,background-color .25s;white-space:nowrap;width:100%}[dir=rtl] .md-version__link{padding-left:1.2rem;padding-right:.6rem}.md-version__link:focus,.md-version__link:hover{color:var(--md-accent-fg-color)}.md-version__link:focus{background-color:var(--md-default-fg-color--lightest)}:root{--md-admonition-icon--note:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--abstract:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--info:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--tip:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--success:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--question:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--warning:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--failure:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--danger:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--bug:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--example:url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--quote:url('data:image/svg+xml;charset=utf-8,')}.md-typeset .admonition,.md-typeset details{background-color:var(--md-admonition-bg-color);border-left:.2rem solid #448aff;border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 .025rem .05rem rgba(0,0,0,.05);color:var(--md-admonition-fg-color);display:flow-root;font-size:.64rem;margin:1.5625em 0;padding:0 .6rem;page-break-inside:avoid}@media print{.md-typeset .admonition,.md-typeset details{box-shadow:none}}[dir=rtl] .md-typeset .admonition,[dir=rtl] .md-typeset details{border-left:none;border-right:.2rem solid #448aff}.md-typeset .admonition .admonition,.md-typeset .admonition details,.md-typeset details .admonition,.md-typeset details details{margin-bottom:1em;margin-top:1em}.md-typeset .admonition .md-typeset__scrollwrap,.md-typeset details .md-typeset__scrollwrap{margin:1em -.6rem}.md-typeset .admonition .md-typeset__table,.md-typeset details .md-typeset__table{padding:0 .6rem}.md-typeset .admonition>.tabbed-set:only-child,.md-typeset details>.tabbed-set:only-child{margin-top:0}html .md-typeset .admonition>:last-child,html .md-typeset details>:last-child{margin-bottom:.6rem}.md-typeset .admonition-title,.md-typeset summary{background-color:rgba(68,138,255,.1);border-left:.2rem solid #448aff;border-top-left-radius:.1rem;font-weight:700;margin:0 -.6rem 0 -.8rem;padding:.4rem .6rem .4rem 2rem;position:relative}[dir=rtl] .md-typeset .admonition-title,[dir=rtl] .md-typeset summary{border-left:none;border-right:.2rem solid #448aff;margin:0 -.8rem 0 -.6rem;padding:.4rem 2rem .4rem .6rem}html .md-typeset .admonition-title:last-child,html .md-typeset summary:last-child{margin-bottom:0}.md-typeset .admonition-title:before,.md-typeset summary:before{background-color:#448aff;content:"";height:1rem;left:.6rem;-webkit-mask-image:var(--md-admonition-icon--note);mask-image:var(--md-admonition-icon--note);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;position:absolute;width:1rem}[dir=rtl] .md-typeset .admonition-title:before,[dir=rtl] .md-typeset summary:before{left:auto;right:.6rem}.md-typeset .admonition-title+.tabbed-set:last-child,.md-typeset summary+.tabbed-set:last-child{margin-top:0}.md-typeset .admonition.note,.md-typeset details.note{border-color:#448aff}.md-typeset .note>.admonition-title,.md-typeset .note>summary{background-color:rgba(68,138,255,.1);border-color:#448aff}.md-typeset .note>.admonition-title:before,.md-typeset .note>summary:before{background-color:#448aff;-webkit-mask-image:var(--md-admonition-icon--note);mask-image:var(--md-admonition-icon--note);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.abstract,.md-typeset .admonition.summary,.md-typeset .admonition.tldr,.md-typeset details.abstract,.md-typeset details.summary,.md-typeset details.tldr{border-color:#00b0ff}.md-typeset .abstract>.admonition-title,.md-typeset .abstract>summary,.md-typeset .summary>.admonition-title,.md-typeset .summary>summary,.md-typeset .tldr>.admonition-title,.md-typeset .tldr>summary{background-color:rgba(0,176,255,.1);border-color:#00b0ff}.md-typeset .abstract>.admonition-title:before,.md-typeset .abstract>summary:before,.md-typeset .summary>.admonition-title:before,.md-typeset .summary>summary:before,.md-typeset .tldr>.admonition-title:before,.md-typeset .tldr>summary:before{background-color:#00b0ff;-webkit-mask-image:var(--md-admonition-icon--abstract);mask-image:var(--md-admonition-icon--abstract);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.info,.md-typeset .admonition.todo,.md-typeset details.info,.md-typeset details.todo{border-color:#00b8d4}.md-typeset .info>.admonition-title,.md-typeset .info>summary,.md-typeset .todo>.admonition-title,.md-typeset .todo>summary{background-color:rgba(0,184,212,.1);border-color:#00b8d4}.md-typeset .info>.admonition-title:before,.md-typeset .info>summary:before,.md-typeset .todo>.admonition-title:before,.md-typeset .todo>summary:before{background-color:#00b8d4;-webkit-mask-image:var(--md-admonition-icon--info);mask-image:var(--md-admonition-icon--info);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.hint,.md-typeset .admonition.important,.md-typeset .admonition.tip,.md-typeset details.hint,.md-typeset details.important,.md-typeset details.tip{border-color:#00bfa5}.md-typeset .hint>.admonition-title,.md-typeset .hint>summary,.md-typeset .important>.admonition-title,.md-typeset .important>summary,.md-typeset .tip>.admonition-title,.md-typeset .tip>summary{background-color:rgba(0,191,165,.1);border-color:#00bfa5}.md-typeset .hint>.admonition-title:before,.md-typeset .hint>summary:before,.md-typeset .important>.admonition-title:before,.md-typeset .important>summary:before,.md-typeset .tip>.admonition-title:before,.md-typeset .tip>summary:before{background-color:#00bfa5;-webkit-mask-image:var(--md-admonition-icon--tip);mask-image:var(--md-admonition-icon--tip);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.check,.md-typeset .admonition.done,.md-typeset .admonition.success,.md-typeset details.check,.md-typeset details.done,.md-typeset details.success{border-color:#00c853}.md-typeset .check>.admonition-title,.md-typeset .check>summary,.md-typeset .done>.admonition-title,.md-typeset .done>summary,.md-typeset .success>.admonition-title,.md-typeset .success>summary{background-color:rgba(0,200,83,.1);border-color:#00c853}.md-typeset .check>.admonition-title:before,.md-typeset .check>summary:before,.md-typeset .done>.admonition-title:before,.md-typeset .done>summary:before,.md-typeset .success>.admonition-title:before,.md-typeset .success>summary:before{background-color:#00c853;-webkit-mask-image:var(--md-admonition-icon--success);mask-image:var(--md-admonition-icon--success);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.faq,.md-typeset .admonition.help,.md-typeset .admonition.question,.md-typeset details.faq,.md-typeset details.help,.md-typeset details.question{border-color:#64dd17}.md-typeset .faq>.admonition-title,.md-typeset .faq>summary,.md-typeset .help>.admonition-title,.md-typeset .help>summary,.md-typeset .question>.admonition-title,.md-typeset .question>summary{background-color:rgba(100,221,23,.1);border-color:#64dd17}.md-typeset .faq>.admonition-title:before,.md-typeset .faq>summary:before,.md-typeset .help>.admonition-title:before,.md-typeset .help>summary:before,.md-typeset .question>.admonition-title:before,.md-typeset .question>summary:before{background-color:#64dd17;-webkit-mask-image:var(--md-admonition-icon--question);mask-image:var(--md-admonition-icon--question);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.attention,.md-typeset .admonition.caution,.md-typeset .admonition.warning,.md-typeset details.attention,.md-typeset details.caution,.md-typeset details.warning{border-color:#ff9100}.md-typeset .attention>.admonition-title,.md-typeset .attention>summary,.md-typeset .caution>.admonition-title,.md-typeset .caution>summary,.md-typeset .warning>.admonition-title,.md-typeset .warning>summary{background-color:rgba(255,145,0,.1);border-color:#ff9100}.md-typeset .attention>.admonition-title:before,.md-typeset .attention>summary:before,.md-typeset .caution>.admonition-title:before,.md-typeset .caution>summary:before,.md-typeset .warning>.admonition-title:before,.md-typeset .warning>summary:before{background-color:#ff9100;-webkit-mask-image:var(--md-admonition-icon--warning);mask-image:var(--md-admonition-icon--warning);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.fail,.md-typeset .admonition.failure,.md-typeset .admonition.missing,.md-typeset details.fail,.md-typeset details.failure,.md-typeset details.missing{border-color:#ff5252}.md-typeset .fail>.admonition-title,.md-typeset .fail>summary,.md-typeset .failure>.admonition-title,.md-typeset .failure>summary,.md-typeset .missing>.admonition-title,.md-typeset .missing>summary{background-color:rgba(255,82,82,.1);border-color:#ff5252}.md-typeset .fail>.admonition-title:before,.md-typeset .fail>summary:before,.md-typeset .failure>.admonition-title:before,.md-typeset .failure>summary:before,.md-typeset .missing>.admonition-title:before,.md-typeset .missing>summary:before{background-color:#ff5252;-webkit-mask-image:var(--md-admonition-icon--failure);mask-image:var(--md-admonition-icon--failure);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.danger,.md-typeset .admonition.error,.md-typeset details.danger,.md-typeset details.error{border-color:#ff1744}.md-typeset .danger>.admonition-title,.md-typeset .danger>summary,.md-typeset .error>.admonition-title,.md-typeset .error>summary{background-color:rgba(255,23,68,.1);border-color:#ff1744}.md-typeset .danger>.admonition-title:before,.md-typeset .danger>summary:before,.md-typeset .error>.admonition-title:before,.md-typeset .error>summary:before{background-color:#ff1744;-webkit-mask-image:var(--md-admonition-icon--danger);mask-image:var(--md-admonition-icon--danger);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.bug,.md-typeset details.bug{border-color:#f50057}.md-typeset .bug>.admonition-title,.md-typeset .bug>summary{background-color:rgba(245,0,87,.1);border-color:#f50057}.md-typeset .bug>.admonition-title:before,.md-typeset .bug>summary:before{background-color:#f50057;-webkit-mask-image:var(--md-admonition-icon--bug);mask-image:var(--md-admonition-icon--bug);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.example,.md-typeset details.example{border-color:#7c4dff}.md-typeset .example>.admonition-title,.md-typeset .example>summary{background-color:rgba(124,77,255,.1);border-color:#7c4dff}.md-typeset .example>.admonition-title:before,.md-typeset .example>summary:before{background-color:#7c4dff;-webkit-mask-image:var(--md-admonition-icon--example);mask-image:var(--md-admonition-icon--example);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}.md-typeset .admonition.cite,.md-typeset .admonition.quote,.md-typeset details.cite,.md-typeset details.quote{border-color:#9e9e9e}.md-typeset .cite>.admonition-title,.md-typeset .cite>summary,.md-typeset .quote>.admonition-title,.md-typeset .quote>summary{background-color:hsla(0,0%,62%,.1);border-color:#9e9e9e}.md-typeset .cite>.admonition-title:before,.md-typeset .cite>summary:before,.md-typeset .quote>.admonition-title:before,.md-typeset .quote>summary:before{background-color:#9e9e9e;-webkit-mask-image:var(--md-admonition-icon--quote);mask-image:var(--md-admonition-icon--quote);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain}:root{--md-footnotes-icon:url('data:image/svg+xml;charset=utf-8,')}.md-typeset .footnote{color:var(--md-default-fg-color--light);font-size:.64rem}.md-typeset .footnote>ol{margin-left:0}.md-typeset .footnote>ol>li{transition:color 125ms}.md-typeset .footnote>ol>li:target{color:var(--md-default-fg-color)}.md-typeset .footnote>ol>li:hover .footnote-backref,.md-typeset .footnote>ol>li:target .footnote-backref{opacity:1;transform:translateX(0)}.md-typeset .footnote>ol>li>:first-child{margin-top:0}.md-typeset .footnote-ref{font-size:.75em;font-weight:700}html .md-typeset .footnote-ref{outline-offset:.1rem}.md-typeset .footnote-backref{color:var(--md-typeset-a-color);display:inline-block;font-size:0;opacity:0;transform:translateX(.25rem);transition:color .25s,transform .25s .25s,opacity 125ms .25s;vertical-align:text-bottom}@media print{.md-typeset .footnote-backref{color:var(--md-typeset-a-color);opacity:1;transform:translateX(0)}}[dir=rtl] .md-typeset .footnote-backref{transform:translateX(-.25rem)}.md-typeset .footnote-backref:hover{color:var(--md-accent-fg-color)}.md-typeset .footnote-backref:before{background-color:currentColor;content:"";display:inline-block;height:.8rem;-webkit-mask-image:var(--md-footnotes-icon);mask-image:var(--md-footnotes-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;width:.8rem}[dir=rtl] .md-typeset .footnote-backref:before svg{transform:scaleX(-1)}.md-typeset [id^="fnref:"]:target{margin-top:-3.4rem;padding-top:3.4rem;scroll-margin-top:0}.md-typeset [id^="fnref:"]:target>.footnote-ref{outline:auto}.md-typeset [id^="fn:"]:target{margin-top:-3.45rem;padding-top:3.45rem;scroll-margin-top:0}.md-typeset .headerlink{color:var(--md-default-fg-color--lighter);display:inline-block;margin-left:.5rem;opacity:0;transition:color .25s,opacity 125ms}@media print{.md-typeset .headerlink{display:none}}[dir=rtl] .md-typeset .headerlink{margin-left:0;margin-right:.5rem}.md-typeset .headerlink:focus,.md-typeset :hover>.headerlink,.md-typeset :target>.headerlink{opacity:1;transition:color .25s,opacity 125ms}.md-typeset .headerlink:focus,.md-typeset .headerlink:hover,.md-typeset :target>.headerlink{color:var(--md-accent-fg-color)}.md-typeset :target{scroll-margin-top:3.6rem}@media screen and (min-width:76.25em){.md-header--lifted~.md-container .md-typeset :target{scroll-margin-top:6rem}}.md-typeset h1:target,.md-typeset h2:target,.md-typeset h3:target{scroll-margin-top:0}.md-typeset h1:target:before,.md-typeset h2:target:before,.md-typeset h3:target:before{content:"";display:block;margin-top:-3.4rem;padding-top:3.4rem}@media screen and (min-width:76.25em){.md-header--lifted~.md-container .md-typeset h1:target,.md-header--lifted~.md-container .md-typeset h2:target,.md-header--lifted~.md-container .md-typeset h3:target{scroll-margin-top:0}.md-header--lifted~.md-container .md-typeset h1:target:before,.md-header--lifted~.md-container .md-typeset h2:target:before,.md-header--lifted~.md-container .md-typeset h3:target:before{margin-top:-5.8rem;padding-top:5.8rem}}.md-typeset h4:target{scroll-margin-top:0}.md-typeset h4:target:before{content:"";display:block;margin-top:-3.45rem;padding-top:3.45rem}@media screen and (min-width:76.25em){.md-header--lifted~.md-container .md-typeset h4:target{scroll-margin-top:0}.md-header--lifted~.md-container .md-typeset h4:target:before{margin-top:-5.85rem;padding-top:5.85rem}}.md-typeset h5:target,.md-typeset h6:target{scroll-margin-top:0}.md-typeset h5:target:before,.md-typeset h6:target:before{content:"";display:block;margin-top:-3.6rem;padding-top:3.6rem}@media screen and (min-width:76.25em){.md-header--lifted~.md-container .md-typeset h5:target,.md-header--lifted~.md-container .md-typeset h6:target{scroll-margin-top:0}.md-header--lifted~.md-container .md-typeset h5:target:before,.md-header--lifted~.md-container .md-typeset h6:target:before{margin-top:-6rem;padding-top:6rem}}.md-typeset div.arithmatex{overflow:auto}@media screen and (max-width:44.9375em){.md-typeset div.arithmatex{margin:0 -.8rem}}.md-typeset div.arithmatex>*{margin:1em auto!important;padding:0 .8rem;touch-action:auto;width:-webkit-min-content;width:-moz-min-content;width:min-content}.md-typeset .critic.comment,.md-typeset del.critic,.md-typeset ins.critic{-webkit-box-decoration-break:clone;box-decoration-break:clone}.md-typeset del.critic{background-color:var(--md-typeset-del-color)}.md-typeset ins.critic{background-color:var(--md-typeset-ins-color)}.md-typeset .critic.comment{color:var(--md-code-hl-comment-color)}.md-typeset .critic.comment:before{content:"/* "}.md-typeset .critic.comment:after{content:" */"}.md-typeset .critic.block{box-shadow:none;display:block;margin:1em 0;overflow:auto;padding-left:.8rem;padding-right:.8rem}.md-typeset .critic.block>:first-child{margin-top:.5em}.md-typeset .critic.block>:last-child{margin-bottom:.5em}:root{--md-details-icon:url('data:image/svg+xml;charset=utf-8,')}.md-typeset details{display:flow-root;overflow:visible;padding-top:0}.md-typeset details[open]>summary:after{transform:rotate(90deg)}.md-typeset details:not([open]){box-shadow:none;padding-bottom:0}.md-typeset details:not([open])>summary{border-radius:.1rem}.md-typeset summary{border-top-left-radius:.1rem;border-top-right-radius:.1rem;cursor:pointer;display:block;min-height:1rem;padding:.4rem 1.8rem .4rem 2rem}[dir=rtl] .md-typeset summary{padding:.4rem 2.2rem .4rem 1.8rem}.md-typeset summary:not(.focus-visible){-webkit-tap-highlight-color:transparent;outline:none}.md-typeset summary:after{background-color:currentColor;content:"";height:1rem;-webkit-mask-image:var(--md-details-icon);mask-image:var(--md-details-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;position:absolute;right:.4rem;top:.4rem;transform:rotate(0deg);transition:transform .25s;width:1rem}[dir=rtl] .md-typeset summary:after{left:.4rem;right:auto;transform:rotate(180deg)}.md-typeset summary::-webkit-details-marker,.md-typeset summary::marker{display:none}.md-typeset .emojione,.md-typeset .gemoji,.md-typeset .twemoji{display:inline-flex;height:1.125em;vertical-align:text-top}.md-typeset .emojione svg,.md-typeset .gemoji svg,.md-typeset .twemoji svg{fill:currentColor;max-height:100%;width:1.125em}.highlight .o,.highlight .ow{color:var(--md-code-hl-operator-color)}.highlight .p{color:var(--md-code-hl-punctuation-color)}.highlight .cpf,.highlight .l,.highlight .s,.highlight .s1,.highlight .s2,.highlight .sb,.highlight .sc,.highlight .si,.highlight .ss{color:var(--md-code-hl-string-color)}.highlight .cp,.highlight .se,.highlight .sh,.highlight .sr,.highlight .sx{color:var(--md-code-hl-special-color)}.highlight .il,.highlight .m,.highlight .mb,.highlight .mf,.highlight .mh,.highlight .mi,.highlight .mo{color:var(--md-code-hl-number-color)}.highlight .k,.highlight .kd,.highlight .kn,.highlight .kp,.highlight .kr,.highlight .kt{color:var(--md-code-hl-keyword-color)}.highlight .kc,.highlight .n{color:var(--md-code-hl-name-color)}.highlight .bp,.highlight .nb,.highlight .no{color:var(--md-code-hl-constant-color)}.highlight .nc,.highlight .ne,.highlight .nf,.highlight .nn{color:var(--md-code-hl-function-color)}.highlight .nd,.highlight .ni,.highlight .nl,.highlight .nt{color:var(--md-code-hl-keyword-color)}.highlight .c,.highlight .c1,.highlight .ch,.highlight .cm,.highlight .cs,.highlight .sd{color:var(--md-code-hl-comment-color)}.highlight .na,.highlight .nv,.highlight .vc,.highlight .vg,.highlight .vi{color:var(--md-code-hl-variable-color)}.highlight .ge,.highlight .gh,.highlight .go,.highlight .gp,.highlight .gr,.highlight .gs,.highlight .gt,.highlight .gu{color:var(--md-code-hl-generic-color)}.highlight .gd,.highlight .gi{border-radius:.1rem;margin:0 -.125em;padding:0 .125em}.highlight .gd{background-color:var(--md-typeset-del-color)}.highlight .gi{background-color:var(--md-typeset-ins-color)}.highlight .hll{background-color:var(--md-code-hl-color);display:block;margin:0 -1.1764705882em;padding:0 1.1764705882em}.highlight [data-linenos]:before{background-color:var(--md-code-bg-color);box-shadow:-.05rem 0 var(--md-default-fg-color--lightest) inset;color:var(--md-default-fg-color--light);content:attr(data-linenos);float:left;left:-1.1764705882em;margin-left:-1.1764705882em;margin-right:1.1764705882em;padding-left:1.1764705882em;position:-webkit-sticky;position:sticky;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;z-index:3}.highlighttable{display:flow-root}.highlighttable tbody,.highlighttable td{display:block;padding:0}.highlighttable tr{display:flex}.highlighttable pre{margin:0}.highlighttable .linenos{background-color:var(--md-code-bg-color);font-size:.85em;padding:.7720588235em 0 .7720588235em 1.1764705882em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.highlighttable .linenodiv{box-shadow:-.05rem 0 var(--md-default-fg-color--lightest) inset;padding-right:.5882352941em}.highlighttable .linenodiv pre{color:var(--md-default-fg-color--light);text-align:right}.highlighttable .code{flex:1;min-width:0}.md-typeset .highlighttable{border-radius:.1rem;direction:ltr;margin:1em 0}.md-typeset .highlighttable code{border-radius:0}@media screen and (max-width:44.9375em){.md-typeset.md-content__inner>.highlight{margin:1em -.8rem}.md-typeset.md-content__inner>.highlight .hll{margin:0 -.8rem;padding:0 .8rem}.md-typeset.md-content__inner>.highlight code{border-radius:0}.md-typeset>.highlighttable{border-radius:0;margin:1em -.8rem}.md-typeset>.highlighttable .hll{margin:0 -.8rem;padding:0 .8rem}}.md-typeset .keys kbd:after,.md-typeset .keys kbd:before{-moz-osx-font-smoothing:initial;-webkit-font-smoothing:initial;color:inherit;margin:0;position:relative}.md-typeset .keys span{color:var(--md-default-fg-color--light);padding:0 .2em}.md-typeset .keys .key-alt:before{content:"⎇";padding-right:.4em}.md-typeset .keys .key-left-alt:before{content:"⎇";padding-right:.4em}.md-typeset .keys .key-right-alt:before{content:"⎇";padding-right:.4em}.md-typeset .keys .key-command:before{content:"⌘";padding-right:.4em}.md-typeset .keys .key-left-command:before{content:"⌘";padding-right:.4em}.md-typeset .keys .key-right-command:before{content:"⌘";padding-right:.4em}.md-typeset .keys .key-control:before{content:"⌃";padding-right:.4em}.md-typeset .keys .key-left-control:before{content:"⌃";padding-right:.4em}.md-typeset .keys .key-right-control:before{content:"⌃";padding-right:.4em}.md-typeset .keys .key-meta:before{content:"◆";padding-right:.4em}.md-typeset .keys .key-left-meta:before{content:"◆";padding-right:.4em}.md-typeset .keys .key-right-meta:before{content:"◆";padding-right:.4em}.md-typeset .keys .key-option:before{content:"⌥";padding-right:.4em}.md-typeset .keys .key-left-option:before{content:"⌥";padding-right:.4em}.md-typeset .keys .key-right-option:before{content:"⌥";padding-right:.4em}.md-typeset .keys .key-shift:before{content:"⇧";padding-right:.4em}.md-typeset .keys .key-left-shift:before{content:"⇧";padding-right:.4em}.md-typeset .keys .key-right-shift:before{content:"⇧";padding-right:.4em}.md-typeset .keys .key-super:before{content:"❖";padding-right:.4em}.md-typeset .keys .key-left-super:before{content:"❖";padding-right:.4em}.md-typeset .keys .key-right-super:before{content:"❖";padding-right:.4em}.md-typeset .keys .key-windows:before{content:"⊞";padding-right:.4em}.md-typeset .keys .key-left-windows:before{content:"⊞";padding-right:.4em}.md-typeset .keys .key-right-windows:before{content:"⊞";padding-right:.4em}.md-typeset .keys .key-arrow-down:before{content:"↓";padding-right:.4em}.md-typeset .keys .key-arrow-left:before{content:"←";padding-right:.4em}.md-typeset .keys .key-arrow-right:before{content:"→";padding-right:.4em}.md-typeset .keys .key-arrow-up:before{content:"↑";padding-right:.4em}.md-typeset .keys .key-backspace:before{content:"⌫";padding-right:.4em}.md-typeset .keys .key-backtab:before{content:"⇤";padding-right:.4em}.md-typeset .keys .key-caps-lock:before{content:"⇪";padding-right:.4em}.md-typeset .keys .key-clear:before{content:"⌧";padding-right:.4em}.md-typeset .keys .key-context-menu:before{content:"☰";padding-right:.4em}.md-typeset .keys .key-delete:before{content:"⌦";padding-right:.4em}.md-typeset .keys .key-eject:before{content:"⏏";padding-right:.4em}.md-typeset .keys .key-end:before{content:"⤓";padding-right:.4em}.md-typeset .keys .key-escape:before{content:"⎋";padding-right:.4em}.md-typeset .keys .key-home:before{content:"⤒";padding-right:.4em}.md-typeset .keys .key-insert:before{content:"⎀";padding-right:.4em}.md-typeset .keys .key-page-down:before{content:"⇟";padding-right:.4em}.md-typeset .keys .key-page-up:before{content:"⇞";padding-right:.4em}.md-typeset .keys .key-print-screen:before{content:"⎙";padding-right:.4em}.md-typeset .keys .key-tab:after{content:"⇥";padding-left:.4em}.md-typeset .keys .key-num-enter:after{content:"⌤";padding-left:.4em}.md-typeset .keys .key-enter:after{content:"⏎";padding-left:.4em}.md-typeset .tabbed-content{box-shadow:0 -.05rem var(--md-default-fg-color--lightest);display:none;order:99;width:100%}@media print{.md-typeset .tabbed-content{display:block;order:0}}.md-typeset .tabbed-content>.highlight:only-child pre,.md-typeset .tabbed-content>.highlighttable:only-child,.md-typeset .tabbed-content>pre:only-child{margin:0}.md-typeset .tabbed-content>.highlight:only-child pre>code,.md-typeset .tabbed-content>.highlighttable:only-child>code,.md-typeset .tabbed-content>pre:only-child>code{border-top-left-radius:0;border-top-right-radius:0}.md-typeset .tabbed-content>.tabbed-set{margin:0}.md-typeset .tabbed-set{border-radius:.1rem;display:flex;flex-wrap:wrap;margin:1em 0;position:relative}.md-typeset .tabbed-set>input{height:0;opacity:0;position:absolute;width:0}.md-typeset .tabbed-set>input:checked+label{border-color:var(--md-accent-fg-color);color:var(--md-accent-fg-color)}.md-typeset .tabbed-set>input:checked+label+.tabbed-content{display:block}.md-typeset .tabbed-set>input:focus+label{outline-color:var(--md-accent-fg-color);outline-style:auto}.md-typeset .tabbed-set>input:not(.focus-visible)+label{-webkit-tap-highlight-color:transparent;outline:none}.md-typeset .tabbed-set>label{border-bottom:.1rem solid transparent;color:var(--md-default-fg-color--light);cursor:pointer;font-size:.64rem;font-weight:700;padding:.9375em 1.25em .78125em;transition:color .25s;width:auto;z-index:1}.no-js .md-typeset .tabbed-set>label{transition:none}.md-typeset .tabbed-set>label:hover{color:var(--md-accent-fg-color)}:root{--md-tasklist-icon:url('data:image/svg+xml;charset=utf-8,');--md-tasklist-icon--checked:url('data:image/svg+xml;charset=utf-8,')}.md-typeset .task-list-item{list-style-type:none;position:relative}.md-typeset .task-list-item [type=checkbox]{left:-2em;position:absolute;top:.45em}[dir=rtl] .md-typeset .task-list-item [type=checkbox]{left:auto;right:-2em}.md-typeset .task-list-control [type=checkbox]{opacity:0;z-index:-1}.md-typeset .task-list-indicator:before{background-color:var(--md-default-fg-color--lightest);content:"";height:1.25em;left:-1.5em;-webkit-mask-image:var(--md-tasklist-icon);mask-image:var(--md-tasklist-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;-webkit-mask-size:contain;mask-size:contain;position:absolute;top:.15em;width:1.25em}[dir=rtl] .md-typeset .task-list-indicator:before{left:auto;right:-1.5em}.md-typeset [type=checkbox]:checked+.task-list-indicator:before{background-color:#00e676;-webkit-mask-image:var(--md-tasklist-icon--checked);mask-image:var(--md-tasklist-icon--checked)}:root>*{--md-mermaid-font-family:var(--md-text-font-family) sans-serif;--md-mermaid-edge-color:var(--md-default-fg-color);--md-mermaid-node-bg-color:var(--md-accent-fg-color--transparent);--md-mermaid-node-fg-color:var(--md-accent-fg-color);--md-mermaid-label-bg-color:var(--md-default-bg-color);--md-mermaid-label-fg-color:var(--md-default-fg-color)}@media screen and (min-width:45em){.md-typeset .inline{float:left;margin-bottom:.8rem;margin-right:.8rem;margin-top:0;width:11.7rem}[dir=rtl] .md-typeset .inline{float:right;margin-left:.8rem;margin-right:0}.md-typeset .inline.end{float:right;margin-left:.8rem;margin-right:0}[dir=rtl] .md-typeset .inline.end{float:left;margin-left:0;margin-right:.8rem}} \ No newline at end of file diff --git a/v4.2.5/assets/stylesheets/palette.73e53a79.min.css b/v4.2.5/assets/stylesheets/palette.73e53a79.min.css new file mode 100644 index 0000000000..03a02114b5 --- /dev/null +++ b/v4.2.5/assets/stylesheets/palette.73e53a79.min.css @@ -0,0 +1 @@ +[data-md-color-accent=red]{--md-accent-fg-color:#ff1947;--md-accent-fg-color--transparent:rgba(255,25,71,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=pink]{--md-accent-fg-color:#f50056;--md-accent-fg-color--transparent:rgba(245,0,86,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=purple]{--md-accent-fg-color:#df41fb;--md-accent-fg-color--transparent:rgba(223,65,251,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=deep-purple]{--md-accent-fg-color:#7c4dff;--md-accent-fg-color--transparent:rgba(124,77,255,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=indigo]{--md-accent-fg-color:#526cfe;--md-accent-fg-color--transparent:rgba(82,108,254,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=blue]{--md-accent-fg-color:#4287ff;--md-accent-fg-color--transparent:rgba(66,135,255,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=light-blue]{--md-accent-fg-color:#0091eb;--md-accent-fg-color--transparent:rgba(0,145,235,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=cyan]{--md-accent-fg-color:#00bad6;--md-accent-fg-color--transparent:rgba(0,186,214,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=teal]{--md-accent-fg-color:#00bda4;--md-accent-fg-color--transparent:rgba(0,189,164,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=green]{--md-accent-fg-color:#00c753;--md-accent-fg-color--transparent:rgba(0,199,83,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=light-green]{--md-accent-fg-color:#63de17;--md-accent-fg-color--transparent:rgba(99,222,23,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-accent=lime]{--md-accent-fg-color:#b0eb00;--md-accent-fg-color--transparent:rgba(176,235,0,0.1);--md-accent-bg-color:rgba(0,0,0,0.87);--md-accent-bg-color--light:rgba(0,0,0,0.54)}[data-md-color-accent=yellow]{--md-accent-fg-color:#ffd500;--md-accent-fg-color--transparent:rgba(255,213,0,0.1);--md-accent-bg-color:rgba(0,0,0,0.87);--md-accent-bg-color--light:rgba(0,0,0,0.54)}[data-md-color-accent=amber]{--md-accent-fg-color:#fa0;--md-accent-fg-color--transparent:rgba(255,170,0,0.1);--md-accent-bg-color:rgba(0,0,0,0.87);--md-accent-bg-color--light:rgba(0,0,0,0.54)}[data-md-color-accent=orange]{--md-accent-fg-color:#ff9100;--md-accent-fg-color--transparent:rgba(255,145,0,0.1);--md-accent-bg-color:rgba(0,0,0,0.87);--md-accent-bg-color--light:rgba(0,0,0,0.54)}[data-md-color-accent=deep-orange]{--md-accent-fg-color:#ff6e42;--md-accent-fg-color--transparent:rgba(255,110,66,0.1);--md-accent-bg-color:#fff;--md-accent-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=red]{--md-primary-fg-color:#ef5552;--md-primary-fg-color--light:#e57171;--md-primary-fg-color--dark:#e53734;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=pink]{--md-primary-fg-color:#e92063;--md-primary-fg-color--light:#ec417a;--md-primary-fg-color--dark:#c3185d;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=purple]{--md-primary-fg-color:#ab47bd;--md-primary-fg-color--light:#bb69c9;--md-primary-fg-color--dark:#8c24a8;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=deep-purple]{--md-primary-fg-color:#7e56c2;--md-primary-fg-color--light:#9574cd;--md-primary-fg-color--dark:#673ab6;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=indigo]{--md-primary-fg-color:#4051b5;--md-primary-fg-color--light:#5d6cc0;--md-primary-fg-color--dark:#303fa1;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=blue]{--md-primary-fg-color:#2094f3;--md-primary-fg-color--light:#42a5f5;--md-primary-fg-color--dark:#1975d2;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=light-blue]{--md-primary-fg-color:#02a6f2;--md-primary-fg-color--light:#28b5f6;--md-primary-fg-color--dark:#0287cf;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=cyan]{--md-primary-fg-color:#00bdd6;--md-primary-fg-color--light:#25c5da;--md-primary-fg-color--dark:#0097a8;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=teal]{--md-primary-fg-color:#009485;--md-primary-fg-color--light:#26a699;--md-primary-fg-color--dark:#007a6c;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=green]{--md-primary-fg-color:#4cae4f;--md-primary-fg-color--light:#68bb6c;--md-primary-fg-color--dark:#398e3d;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=light-green]{--md-primary-fg-color:#8bc34b;--md-primary-fg-color--light:#9ccc66;--md-primary-fg-color--dark:#689f38;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=lime]{--md-primary-fg-color:#cbdc38;--md-primary-fg-color--light:#d3e156;--md-primary-fg-color--dark:#b0b52c;--md-primary-bg-color:rgba(0,0,0,0.87);--md-primary-bg-color--light:rgba(0,0,0,0.54)}[data-md-color-primary=yellow]{--md-primary-fg-color:#ffec3d;--md-primary-fg-color--light:#ffee57;--md-primary-fg-color--dark:#fbc02d;--md-primary-bg-color:rgba(0,0,0,0.87);--md-primary-bg-color--light:rgba(0,0,0,0.54)}[data-md-color-primary=amber]{--md-primary-fg-color:#ffc105;--md-primary-fg-color--light:#ffc929;--md-primary-fg-color--dark:#ffa200;--md-primary-bg-color:rgba(0,0,0,0.87);--md-primary-bg-color--light:rgba(0,0,0,0.54)}[data-md-color-primary=orange]{--md-primary-fg-color:#ffa724;--md-primary-fg-color--light:#ffa724;--md-primary-fg-color--dark:#fa8900;--md-primary-bg-color:rgba(0,0,0,0.87);--md-primary-bg-color--light:rgba(0,0,0,0.54)}[data-md-color-primary=deep-orange]{--md-primary-fg-color:#ff6e42;--md-primary-fg-color--light:#ff8a66;--md-primary-fg-color--dark:#f4511f;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=brown]{--md-primary-fg-color:#795649;--md-primary-fg-color--light:#8d6e62;--md-primary-fg-color--dark:#5d4037;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=grey]{--md-primary-fg-color:#757575;--md-primary-fg-color--light:#9e9e9e;--md-primary-fg-color--dark:#616161;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=blue-grey]{--md-primary-fg-color:#546d78;--md-primary-fg-color--light:#607c8a;--md-primary-fg-color--dark:#455a63;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7)}[data-md-color-primary=white]{--md-primary-fg-color:#fff;--md-primary-fg-color--light:hsla(0,0%,100%,0.7);--md-primary-fg-color--dark:rgba(0,0,0,0.07);--md-primary-bg-color:rgba(0,0,0,0.87);--md-primary-bg-color--light:rgba(0,0,0,0.54);--md-typeset-a-color:#4051b5}@media screen and (min-width:60em){[data-md-color-primary=white] .md-search__form{background-color:rgba(0,0,0,.07)}[data-md-color-primary=white] .md-search__form:hover{background-color:rgba(0,0,0,.32)}[data-md-color-primary=white] .md-search__input+.md-search__icon{color:rgba(0,0,0,.87)}}@media screen and (min-width:76.25em){[data-md-color-primary=white] .md-tabs{border-bottom:.05rem solid rgba(0,0,0,.07)}}[data-md-color-primary=black]{--md-primary-fg-color:#000;--md-primary-fg-color--light:rgba(0,0,0,0.54);--md-primary-fg-color--dark:#000;--md-primary-bg-color:#fff;--md-primary-bg-color--light:hsla(0,0%,100%,0.7);--md-typeset-a-color:#4051b5}[data-md-color-primary=black] .md-header{background-color:#000}@media screen and (max-width:59.9375em){[data-md-color-primary=black] .md-nav__source{background-color:rgba(0,0,0,.87)}}@media screen and (min-width:60em){[data-md-color-primary=black] .md-search__form{background-color:hsla(0,0%,100%,.12)}[data-md-color-primary=black] .md-search__form:hover{background-color:hsla(0,0%,100%,.3)}}@media screen and (max-width:76.1875em){html [data-md-color-primary=black] .md-nav--primary .md-nav__title[for=__drawer]{background-color:#000}}@media screen and (min-width:76.25em){[data-md-color-primary=black] .md-tabs{background-color:#000}}@media screen{[data-md-color-scheme=slate]{--md-hue:232;--md-default-fg-color:hsla(var(--md-hue),75%,95%,1);--md-default-fg-color--light:hsla(var(--md-hue),75%,90%,0.62);--md-default-fg-color--lighter:hsla(var(--md-hue),75%,90%,0.32);--md-default-fg-color--lightest:hsla(var(--md-hue),75%,90%,0.12);--md-default-bg-color:hsla(var(--md-hue),15%,21%,1);--md-default-bg-color--light:hsla(var(--md-hue),15%,21%,0.54);--md-default-bg-color--lighter:hsla(var(--md-hue),15%,21%,0.26);--md-default-bg-color--lightest:hsla(var(--md-hue),15%,21%,0.07);--md-code-fg-color:hsla(var(--md-hue),18%,86%,1);--md-code-bg-color:hsla(var(--md-hue),15%,15%,1);--md-code-hl-color:rgba(66,135,255,0.15);--md-code-hl-number-color:#e6695b;--md-code-hl-special-color:#f06090;--md-code-hl-function-color:#c973d9;--md-code-hl-constant-color:#9383e2;--md-code-hl-keyword-color:#6791e0;--md-code-hl-string-color:#2fb170;--md-code-hl-name-color:var(--md-code-fg-color);--md-code-hl-operator-color:var(--md-default-fg-color--light);--md-code-hl-punctuation-color:var(--md-default-fg-color--light);--md-code-hl-comment-color:var(--md-default-fg-color--light);--md-code-hl-generic-color:var(--md-default-fg-color--light);--md-code-hl-variable-color:var(--md-default-fg-color--light);--md-typeset-color:var(--md-default-fg-color);--md-typeset-a-color:var(--md-primary-fg-color);--md-typeset-mark-color:rgba(66,135,255,0.3);--md-typeset-kbd-color:hsla(var(--md-hue),15%,94%,0.12);--md-typeset-kbd-accent-color:hsla(var(--md-hue),15%,94%,0.2);--md-typeset-kbd-border-color:hsla(var(--md-hue),15%,14%,1);--md-admonition-bg-color:hsla(var(--md-hue),0%,100%,0.025);--md-footer-bg-color:hsla(var(--md-hue),15%,12%,0.87);--md-footer-bg-color--dark:hsla(var(--md-hue),15%,10%,1)}[data-md-color-scheme=slate][data-md-color-primary=black],[data-md-color-scheme=slate][data-md-color-primary=white]{--md-typeset-a-color:#5d6cc0}} \ No newline at end of file diff --git a/v4.2.5/clusters/adding-clusters/index.html b/v4.2.5/clusters/adding-clusters/index.html new file mode 100644 index 0000000000..38118b6e92 --- /dev/null +++ b/v4.2.5/clusters/adding-clusters/index.html @@ -0,0 +1,1163 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Adding Clusters - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Adding Clusters#

+

Add clusters by clicking the Add Cluster button in the left-side menu.

+
    +
  1. Click the Add Cluster button (indicated with a '+' icon). Or click here.
    2. +
  2. Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly.
    3. +
+

Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts.

+

NOTE: Any cluster that you added manually will not be merged into your kubeconfig file.

+

Add Cluster

+

For more information on kubeconfig see Kubernetes docs.

+

To see your currently-enabled config with kubectl, enter kubectl config view --minify --raw in your terminal.

+

When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known "gotchas" in some authentication types used in kubeconfig with Lens app.

+

Exec auth plugins#

+

When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/clusters/images/add-cluster.png b/v4.2.5/clusters/images/add-cluster.png new file mode 100644 index 0000000000..fa7b632026 Binary files /dev/null and b/v4.2.5/clusters/images/add-cluster.png differ diff --git a/v4.2.5/clusters/images/cluster-context-menu.png b/v4.2.5/clusters/images/cluster-context-menu.png new file mode 100644 index 0000000000..d733840df3 Binary files /dev/null and b/v4.2.5/clusters/images/cluster-context-menu.png differ diff --git a/v4.2.5/clusters/images/cluster-settings-features.png b/v4.2.5/clusters/images/cluster-settings-features.png new file mode 100644 index 0000000000..3a8066309d Binary files /dev/null and b/v4.2.5/clusters/images/cluster-settings-features.png differ diff --git a/v4.2.5/clusters/images/cluster-settings-general.png b/v4.2.5/clusters/images/cluster-settings-general.png new file mode 100644 index 0000000000..d7de0a1a35 Binary files /dev/null and b/v4.2.5/clusters/images/cluster-settings-general.png differ diff --git a/v4.2.5/clusters/images/cluster-settings-removal.png b/v4.2.5/clusters/images/cluster-settings-removal.png new file mode 100644 index 0000000000..badcbcc6e0 Binary files /dev/null and b/v4.2.5/clusters/images/cluster-settings-removal.png differ diff --git a/v4.2.5/clusters/images/cluster-settings-status.png b/v4.2.5/clusters/images/cluster-settings-status.png new file mode 100644 index 0000000000..af8e939e35 Binary files /dev/null and b/v4.2.5/clusters/images/cluster-settings-status.png differ diff --git a/v4.2.5/clusters/images/cluster-settings.png b/v4.2.5/clusters/images/cluster-settings.png new file mode 100644 index 0000000000..27a4a72ff9 Binary files /dev/null and b/v4.2.5/clusters/images/cluster-settings.png differ diff --git a/v4.2.5/clusters/images/remove-cluster.png b/v4.2.5/clusters/images/remove-cluster.png new file mode 100644 index 0000000000..bcaa69c44a Binary files /dev/null and b/v4.2.5/clusters/images/remove-cluster.png differ diff --git a/v4.2.5/clusters/removing-clusters/index.html b/v4.2.5/clusters/removing-clusters/index.html new file mode 100644 index 0000000000..629a182414 --- /dev/null +++ b/v4.2.5/clusters/removing-clusters/index.html @@ -0,0 +1,1113 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Removing Clusters - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Removing Clusters#

+

Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove.

+

To remove a cluster from your cluster list:

+
    +
  1. Right-click the name of the cluster in the left-side menu that you want to remove.
    2. +
  2. Click Remove.
    3. +
+

NOTE: This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.

+

Remove Cluster

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/clusters/settings/index.html b/v4.2.5/clusters/settings/index.html new file mode 100644 index 0000000000..cabf5288d7 --- /dev/null +++ b/v4.2.5/clusters/settings/index.html @@ -0,0 +1,1397 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Settings - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Settings#

+

It is easy to configure Lens Clusters to your liking through its various settings.

+
    +
  1. Right-click the name of the cluster in the left-side menu that you want to open the settings for.
    2. +
  2. Click Settings.
    3. +
+

Cluster settings

+

Status#

+

Overview of the cluster status

+

Cluster Status#

+

Cluster status information including the detected distribution, kernel version, API endpoint, and online status

+

Cluster settings status

+

General#

+

General cluster settings

+

Cluster Name#

+

The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.

+

Workspace#

+

This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in "Define cluster workspace" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.

+

Cluster Icon#

+

Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.

+

HTTP Proxy#

+

Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.

+

Prometheus#

+

Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations:

+
    +
  • Lens
    • +
  • Helm Operator
    • +
  • Prometheus Operator
    • +
  • Stacklight
    • +
+

To learn more about custom Prometheus configurations, please refer to this guide.

+

Working Directory#

+

Use this field to set the terminal working directory. The default is $HOME.

+

Cluster settings general

+

Features#

+

Additional Lens features that can be installed by the user

+

Metrics#

+

Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.

+

User Mode#

+

User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.

+

Cluster settings features

+

Removal#

+

Use this setting to remove the current cluster.

+

Cluster settings removal

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/contributing/development/index.html b/v4.2.5/contributing/development/index.html new file mode 100644 index 0000000000..5b817f6034 --- /dev/null +++ b/v4.2.5/contributing/development/index.html @@ -0,0 +1,1267 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Development - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Development#

+

Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens.

+

When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.

+ + +

Local Development Environment#

+
+

Prerequisites: Nodejs v12, make, yarn

+
+
    +
  • make dev - builds and starts the app
    • +
  • make clean - cleanup local environment build artifacts
    • +
+

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:

+ +

Code Testing#

+

All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. +In fact, we recommend it, because it will save on many possible review iterations and automated tests. +The testing guidelines can be found here:

+ +

License#

+

By contributing, you agree that your contributions will be licensed as described in LICENSE.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/contributing/documentation/index.html b/v4.2.5/contributing/documentation/index.html new file mode 100644 index 0000000000..a1a5ec7bbb --- /dev/null +++ b/v4.2.5/contributing/documentation/index.html @@ -0,0 +1,1205 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Documentation - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Documentation#

+

We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source.

+

Finding Documentation Issues to Work On#

+

You can find a list of open documentation-related issues here. When you find something you would like to work on:

+
    +
  1. Express your interest to start working on an issue via comments.
    2. +
  2. One of the maintainers will assign the issue for you.
    3. +
  3. You can start working on the issue. When you're done, simply submit a pull request.
    4. +
+

Requirements for Documentation Pull Requests#

+

When you create a new pull request, we expect some requirements to be met.

+
    +
  • Follow this naming convention for Pull Requests:
    • +
  • When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started
    • +
  • When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started
    • +
  • When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started
    • +
  • If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close.
    • +
  • For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.
    • +
+

Testing Documentation Site Locally#

+

Run a local instance of mkdocs in a docker container for developing the Lens Documentation.

+
+

Prerequisites: docker, yarn

+
+
    +
  • make docs - local build and serve of mkdocs with auto update enabled
    • +
+

Go to localhost:8000.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/contributing/github_workflow/index.html b/v4.2.5/contributing/github_workflow/index.html new file mode 100644 index 0000000000..fe15a9fa38 --- /dev/null +++ b/v4.2.5/contributing/github_workflow/index.html @@ -0,0 +1,1237 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Github Workflow - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Github Workflow#

+ + + +

This guide assumes you have already cloned the upstream repo to your system via git clone.

+

Fork The Project#

+
    +
  1. Go to http://github.com/lensapp/lens
    2. +
  2. On the top, right-hand side, click on "fork" and select your username for the fork destination.
    3. +
+

Adding the Forked Remote#

+
export GITHUB_USER={ your github's username }
+
+cd $WORKDIR/lens
+git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git
+
+# Prevent push to Upstream
+git remote set-url --push origin no_push
+
+# Set your fork remote as a default push target
+git push --set-upstream $GITHUB_USER master
+
+

Your remotes should look something like this:

+
➜ git remote -v
+origin  https://github.com/lensapp/lens (fetch)
+origin  no_push (push)
+my_fork git@github.com:{ github_username }/lens.git (fetch)
+my_fork git@github.com:{ github_username }/lens.git (push)
+
+

Create & Rebase Your Feature Branch#

+

Create a feature branch:

+
git branch -b my_feature_branch
+
+

Rebase your branch:

+
git fetch origin
+
+git rebase origin/master
+Current branch my_feature_branch is up to date.
+
+

Please don't use git pull instead of the above fetch / rebase. git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful.

+

Commit & Push#

+

Commit and sign your changes:

+
git commit -m "my commit title" --signoff
+
+

You can go back and edit/build/test some more, then commit --amend in a few cycles.

+

When ready, push your changes to your fork's repository:

+
git push --set-upstream my_fork my_feature_branch
+
+

Open a Pull Request#

+

See Github Docs.

+

Get a code review#

+

Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests.

+

Commit changes made in response to review comments should be added to the same branch on your fork.

+

Very small PRs are easy to review. Very large PRs are very difficult to review.

+

Squashing Commits#

+

Commits on your branch should represent meaningful milestones or units of work. +Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed.

+

To do that, it's best to perform an interactive rebase:

+

Example#

+

If you PR has 3 commits, count backwards from your last commit using HEAD~3: +

git rebase -i HEAD~3
+
+Output would be similar to this: +
pick f7f3f6d Changed some code
+pick 310154e fixed some typos
+pick a5f4a0d made some review changes
+
+# Rebase 710f0f8..a5f4a0d onto 710f0f8
+#
+# Commands:
+# p, pick <commit> = use commit
+# r, reword <commit> = use commit, but edit the commit message
+# e, edit <commit> = use commit, but stop for amending
+# s, squash <commit> = use commit, but meld into previous commit
+# f, fixup <commit> = like "squash", but discard this commit's log message
+# x, exec <command> = run command (the rest of the line) using shell
+# b, break = stop here (continue rebase later with 'git rebase --continue')
+# d, drop <commit> = remove commit
+# l, label <label> = label current HEAD with a name
+# t, reset <label> = reset HEAD to a label
+# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
+# .       create a merge commit using the original merge commit's
+# .       message (or the oneline, if no original merge commit was
+# .       specified). Use -c <commit> to reword the commit message.
+#
+# These lines can be re-ordered; they are executed from top to bottom.
+#
+# However, if you remove everything, the rebase will be aborted.
+#
+# Note that empty commits are commented out
+
+Use a command line text editor to change the word pick to fixup for the commits you want to squash, then save your changes and continue the rebase:

+

Per the output above, you can see that: +

fixup <commit> = like "squash", but discard this commit's log message
+
+Which means that when rebased, the commit message "fixed some typos" will be removed, and squashed with the parent commit.

+

Push Your Final Changes#

+

Once done, you can push the final commits to your branch: +

git push --force
+
+You can run multiple iteration of rebase/push -f, if needed.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/contributing/index.html b/v4.2.5/contributing/index.html new file mode 100644 index 0000000000..15e44ea742 --- /dev/null +++ b/v4.2.5/contributing/index.html @@ -0,0 +1,1162 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Contributing#

+

There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues.

+

Here are some ways you can contribute!

+ +

If you are an influencer, blogger, or journalist, feel free to spread the word!

+

Code of Conduct#

+

This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/contributing/maintainers/index.html b/v4.2.5/contributing/maintainers/index.html new file mode 100644 index 0000000000..aa9aeaad38 --- /dev/null +++ b/v4.2.5/contributing/maintainers/index.html @@ -0,0 +1,1178 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Maintainers - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Maintainers#

+

We are looking for community maintainers for the Lens project. Maintainers will be added to a special team with write permissions. These permissions consist of opening, closing, tagging, and editing issues and pull requests, as well as creating and deleting non-protected branches.

+

The responsibilities of a community maintainer are listed below.

+

Issues Triage#

+
    +
  • Labeling Issues: Label issues accordingly.
    • +
  • Finding Duplicates: Finding and closing duplicate issues.
    • +
  • Doing First Level Contact: Getting more information on the issues (like version number or asking for clarification) if needed.
    • +
  • Closing Irrelevant Issues: Closing issues that are determined irrelevant, no longer needed, not relevant to the project and/or don't follow the issues guidelines.
    • +
+

Help with Contributions#

+
    +
  • Help Manage Pull Requests: Help the author of the pull request with any problems.
    • +
  • Contributing: Create pull requests to help maintain and drive the project forward.
    • +
+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/contributing/promotion/index.html b/v4.2.5/contributing/promotion/index.html new file mode 100644 index 0000000000..7b57a54795 --- /dev/null +++ b/v4.2.5/contributing/promotion/index.html @@ -0,0 +1,1186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Promotion - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Promotion#

+

Help promote Lens! If you are not a developer (or even if you are), you can still contribute to the project – a lot – by helping us to promote it. As we are a free and open source project, the community is our most important asset. Here are some ways that you can help the project continue to grow.

+

Follow, Like, Recommend, Favorite, Vote and Star Us#

+

There are many sites where you can vote, recommend, favorite, and star us.

+
    +
  • Twitter - Like, comment and retweet our posts, and follow us on Twitter.
    • +
  • Medium - Give claps to our articles and follow us on Medium.
    • +
  • GitHub - Become a stargazer on GitHub.
    • +
  • StackShare - Indicate you are using Lens and follow us on StackShare.
    • +
  • Reddit - Upvote and be a Lens ambassador by participating in relevant discussions on Reddit.
    • +
  • Hacker News - Upvote and be a Lens ambassador by participating in relevant discussions on Hacker News.
    • +
+

Write Blogs or Make Videos About Us#

+

Here are some nice blog posts and videos about our project for you to get some inspiration:

+ +

Psst... If you have created some content around Lens, let us know!

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/contributing/testing/index.html b/v4.2.5/contributing/testing/index.html new file mode 100644 index 0000000000..f0963d7650 --- /dev/null +++ b/v4.2.5/contributing/testing/index.html @@ -0,0 +1,1122 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Testing - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Testing

+ +

Testing Your Code#

+

Lens uses github actions to run automated tests on any PR, before merging. +However, a PR will not be reviewed before all tests are green, so to save time and prevent your PR from going stale, it is best to test it before submitting the PR.

+

Run Local Verifications#

+

Please run the following style and formatting commands and fix/check-in any changes:

+

1. Linting#

+

We use ESLing for style verification. +In the repository's root directory, simply run:

+
make lint
+
+

3. Pre-submit Flight Checks#

+

In the repository root directory, make sure that:

+
    +
  • make build runs successfully.
    • +
  • make test runs successfully.
    • +
  • make integration runs successfully (some tests require minikube running).
    • +
+

Please note that this last test is prone to "flakiness", so it might fail on occasion. If it fails constantly, take a deeper look at your code to find the source of the problem.

+

If you find that all tests passed, you may open a pull request upstream.

+

Opening A Pull Request#

+

Draft Mode#

+

You may open a pull request in draft mode. +All automated tests will still run against the PR, but the PR will not be assigned for review. +Once a PR is ready for review, transition it from Draft mode, and code owners will be notified.

+

Pre-Requisites for PR Merge#

+

In order for a PR to be merged, the following conditions should exist: +1. The PR has passed all the automated tests (style, build & conformance tests). +2. PR commits have been signed with the --signoff option. +3. PR was reviewed and approved by a code owner. +4. PR is rebased against upstream's master branch.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/custom_theme/img/favicon.ico b/v4.2.5/custom_theme/img/favicon.ico new file mode 100644 index 0000000000..19b2de71d1 Binary files /dev/null and b/v4.2.5/custom_theme/img/favicon.ico differ diff --git a/v4.2.5/custom_theme/main.html b/v4.2.5/custom_theme/main.html new file mode 100644 index 0000000000..b6ad2467dd --- /dev/null +++ b/v4.2.5/custom_theme/main.html @@ -0,0 +1,12 @@ +{% extends "base.html" %} + +{% block analytics %} + + + +{% endblock %} \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html b/v4.2.5/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html new file mode 100644 index 0000000000..9d825b4f35 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html @@ -0,0 +1,1434 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ClusterFeature - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ClusterFeature#

+

Hierarchy#

+
    +
  • ClusterFeature
    • +
+

Index#

+

Properties#

+ +

Methods#

+ +

Object literals#

+ +

Properties#

+

templateContext#

+

• templateContext: any

+

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

+

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

+

Methods#

+

Protected applyResources#

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
clusterClusterthe cluster that the resources are to be applied to
resourceSpecstring | string[]as a string type this is a folder path that is searched for files specifying kubernetes resources. The files are read and if any of the resource files are templated, the template parameters are filled using the templateContext field (See renderTemplate() method). Finally the resources are applied to the cluster. As a string[] type resourceSpec is treated as an array of fully formed (not templated) kubernetes resources that are applied to the cluster
+

Returns: Promise‹void›

+
+

Abstract install#

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
clusterClusterthe cluster that the feature is to be installed on
+

Returns: Promise‹void›

+
+

Protected renderTemplates#

+

▸ renderTemplates(folderPath: string): string[]

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
folderPathstringthis is a folder path that is searched for files defining kubernetes resources.
+

Returns: string[]

+

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

+
+

Abstract uninstall#

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
clusterClusterthe cluster that the feature is to be uninstalled from
+

Returns: Promise‹void›

+
+

Abstract updateStatus#

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
clusterClusterthe cluster that the feature may be installed on
+

Returns: Promise‹ClusterFeatureStatus›

+

a promise, resolved with the updated ClusterFeatureStatus

+
+

Abstract upgrade#

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
clusterClusterthe cluster that the feature is to be upgraded on
+

Returns: Promise‹void›

+

Object literals#

+

status#

+

▪ status: object#

+

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

+

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

+

canUpgrade#

+

• canUpgrade: false = false

+

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

+

currentVersion#

+

• currentVersion: null = null

+

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

+

installed#

+

• installed: false = false

+

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

+

latestVersion#

+

• latestVersion: null = null

+

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

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_core_api_stores_.cluster/index.html b/v4.2.5/extensions/api/classes/_core_api_stores_.cluster/index.html new file mode 100644 index 0000000000..923409947f --- /dev/null +++ b/v4.2.5/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -0,0 +1,2383 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:257

+

Parameters:

+ + + + + + + + + + + + + +
NameType
modelClusterModel
+

Returns: Cluster

+

Properties#

+

accessible#

+

• accessible: boolean = false

+

Defined in src/main/cluster.ts:150

+

Can user access cluster resources

+

observable

+
+

accessibleNamespaces#

+

• accessibleNamespaces: string[] = []

+

Implementation of ClusterModel.accessibleNamespaces

+

Defined in src/main/cluster.ts:218

+

List of accessible namespaces provided by user in the Cluster Settings

+

observable

+
+

Protected activated#

+

• activated: boolean = false

+

Defined in src/main/cluster.ts:83

+
+

allowedNamespaces#

+

• allowedNamespaces: string[] = []

+

Defined in src/main/cluster.ts:205

+

List of allowed namespaces verified via K8S::SelfSubjectAccessReview api

+

observable

+
+

allowedResources#

+

• allowedResources: string[] = []

+

Defined in src/main/cluster.ts:212

+

List of allowed resources

+

observable

+

internal

+
+

apiUrl#

+

• apiUrl: string

+

Defined in src/main/cluster.ts:125

+

Kubernetes API server URL

+

observable

+
+

contextHandler#

+

• contextHandler: ContextHandler

+

Defined in src/main/cluster.ts:74

+

Context handler

+

internal

+
+

contextName#

+

• contextName: string

+

Implementation of ClusterModel.contextName

+

Defined in src/main/cluster.ts:107

+

Kubeconfig context name

+

observable

+
+

disconnected#

+

• disconnected: boolean = true

+

Defined in src/main/cluster.ts:168

+

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

+

observable

+
+

enabled#

+

• enabled: boolean = false

+

Defined in src/main/cluster.ts:138

+

Is cluster instance enabled (disabled clusters are currently hidden)

+

observable

+
+

Protected eventDisposers#

+

• eventDisposers: Function[] = []

+

Defined in src/main/cluster.ts:82

+
+

failureReason#

+

• failureReason: string

+

Defined in src/main/cluster.ts:174

+

Connection failure reason

+

observable

+
+

Protected getAllowedNamespacesErrorCount#

+

• getAllowedNamespacesErrorCount: number = 0

+

Defined in src/main/cluster.ts:685

+
+

id#

+

• id: ClusterId

+

Implementation of ClusterModel.id

+

Defined in src/main/cluster.ts:62

+

Unique id for a cluster

+
+

initialized#

+

• initialized: boolean = false

+

Defined in src/main/cluster.ts:101

+

Is cluster object initialized

+

observable

+
+

initializing#

+

• initializing: boolean = false

+

Defined in src/main/cluster.ts:94

+

Is cluster object initializinng on-going

+

observable

+
+

isAdmin#

+

• isAdmin: boolean = false

+

Defined in src/main/cluster.ts:180

+

Does user have admin like access

+

observable

+
+

isGlobalWatchEnabled#

+

• isGlobalWatchEnabled: boolean = false

+

Defined in src/main/cluster.ts:187

+

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

+

Path to kubeconfig

+

observable

+
+

kubeCtl#

+

• kubeCtl: Kubectl

+

Defined in src/main/cluster.ts:68

+

Kubectl

+

internal

+
+

kubeProxyUrl#

+

• kubeProxyUrl: string

+

Defined in src/main/cluster.ts:132

+

Internal authentication proxy URL

+

observable

+

internal

+
+

Protected kubeconfigManager#

+

• kubeconfigManager: KubeconfigManager

+

Defined in src/main/cluster.ts:81

+
+

metadata#

+

• metadata: ClusterMetadata

+

Implementation of ClusterModel.metadata

+

Defined in src/main/cluster.ts:199

+

Metadata

+

observable

+
+

online#

+

• online: boolean = false

+

Defined in src/main/cluster.ts:144

+

Is cluster online

+

observable

+
+

ownerRef#

+

• ownerRef: string

+

Implementation of ClusterModel.ownerRef

+

Defined in src/main/cluster.ts:80

+

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

+

Preferences

+

observable

+
+

ready#

+

• ready: boolean = false

+

Defined in src/main/cluster.ts:156

+

Is cluster instance in usable state

+

observable

+
+

reconnecting#

+

• reconnecting: boolean = false

+

Defined in src/main/cluster.ts:162

+

Is cluster currently reconnecting

+

observable

+
+

whenInitialized#

+

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

+

Defined in src/main/cluster.ts:86

+
+

whenReady#

+

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

+

Defined in src/main/cluster.ts:87

+
+

workspace#

+

• workspace: WorkspaceId

+

Implementation of ClusterModel.workspace

+

Defined in src/main/cluster.ts:113

+

Workspace id

+

observable

+

Accessors#

+

available#

+

• get available(): boolean

+

Defined in src/main/cluster.ts:225

+

Is cluster available

+

computed

+

Returns: boolean

+
+

isManaged#

+

• get isManaged(): boolean

+

Defined in src/main/cluster.ts:277

+

Is cluster managed by an extension

+

Returns: boolean

+
+

name#

+

• get name(): string

+

Defined in src/main/cluster.ts:234

+

Cluster name

+

computed

+

Returns: string

+
+

prometheusPreferences#

+

• get prometheusPreferences(): ClusterPrometheusPreferences

+

Defined in src/main/cluster.ts:244

+

Prometheus preferences

+

computed

+

internal

+

Returns: ClusterPrometheusPreferences

+
+

version#

+

• get version(): string

+

Defined in src/main/cluster.ts:255

+

Kubernetes version

+

Returns: string

+

Methods#

+

activate#

+

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

+

Defined in src/main/cluster.ts:357

+

internal

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
forcebooleanfalseforce activation
+

Returns: Promise‹void›

+
+

Protected bindEvents#

+

▸ bindEvents(): void

+

Defined in src/main/cluster.ts:326

+

internal

+

Returns: void

+
+

canI#

+

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

+

Defined in src/main/cluster.ts:574

+

internal

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
resourceAttributesV1ResourceAttributesresource attributes
+

Returns: Promise‹boolean›

+
+

canUseWatchApi#

+

▸ canUseWatchApi(customizeResource: V1ResourceAttributes): Promise‹boolean›

+

Defined in src/main/cluster.ts:606

+

internal

+

Parameters:

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

Returns: Promise‹boolean›

+
+

disconnect#

+

▸ disconnect(): void

+

Defined in src/main/cluster.ts:405

+

internal

+

Returns: void

+
+

Protected ensureKubectl#

+

▸ ensureKubectl(): Promise‹boolean›

+

Defined in src/main/cluster.ts:385

+

internal

+

Returns: Promise‹boolean›

+
+

Protected getAllowedNamespaces#

+

▸ getAllowedNamespaces(): Promise‹string[]›

+

Defined in src/main/cluster.ts:687

+

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

+

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

+

Returns: Promise‹ClusterStatus›

+
+

Protected getKubeconfig#

+

▸ getKubeconfig(): KubeConfig

+

Defined in src/main/cluster.ts:483

+

Returns: KubeConfig

+
+

getMeta#

+

▸ getMeta(): object

+

Defined in src/main/cluster.ts:673

+

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

+

internal

+

Parameters:

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

Returns: Promise‹any›

+
+

getProxyKubeconfig#

+

▸ getProxyKubeconfig(): Promise‹KubeConfig›

+

Defined in src/main/cluster.ts:490

+

internal

+

Returns: Promise‹KubeConfig›

+
+

getProxyKubeconfigPath#

+

▸ getProxyKubeconfigPath(): Promise‹string›

+

Defined in src/main/cluster.ts:499

+

internal

+

Returns: Promise‹string›

+
+

getState#

+

▸ getState(): ClusterState

+

Defined in src/main/cluster.ts:634

+

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

+

Returns: ClusterState

+
+

init#

+

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

+

Defined in src/main/cluster.ts:297

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
kindstring
+

Returns: boolean

+
+

isClusterAdmin#

+

▸ isClusterAdmin(): Promise‹boolean›

+

Defined in src/main/cluster.ts:595

+

internal

+

Returns: Promise‹boolean›

+
+

isMetricHidden#

+

▸ isMetricHidden(resource: ResourceType): boolean

+

Defined in src/main/cluster.ts:319

+

Parameters:

+ + + + + + + + + + + + + +
NameType
resourceResourceType
+

Returns: boolean

+
+

Protected k8sRequest#

+

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

+

Defined in src/main/cluster.ts:503

+

Type parameters:

+

▪ T

+

Parameters:

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

Returns: Promise‹T›

+
+

pushState#

+

▸ pushState(state: ClusterState): void

+

Defined in src/main/cluster.ts:667

+

internal

+

Parameters:

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

Returns: void

+
+

reconnect#

+

▸ reconnect(): Promise‹void›

+

Defined in src/main/cluster.ts:395

+

internal

+

Returns: Promise‹void›

+
+

refresh#

+

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

+

Defined in src/main/cluster.ts:424

+

internal

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
optsClusterRefreshOptions{}refresh options
+

Returns: Promise‹void›

+
+

refreshAllowedResources#

+

▸ refreshAllowedResources(): Promise‹void›

+

Defined in src/main/cluster.ts:478

+

internal

+

Returns: Promise‹void›

+
+

refreshConnectionStatus#

+

▸ refreshConnectionStatus(): Promise‹void›

+

Defined in src/main/cluster.ts:467

+

internal

+

Returns: Promise‹void›

+
+

refreshMetadata#

+

▸ refreshMetadata(): Promise‹void›

+

Defined in src/main/cluster.ts:443

+

internal

+

Returns: Promise‹void›

+
+

setState#

+

▸ setState(state: ClusterState): void

+

Defined in src/main/cluster.ts:659

+

internal

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
stateClusterStatecluster state
+

Returns: void

+
+

toJSON#

+

▸ toJSON(): ClusterModel

+

Defined in src/main/cluster.ts:614

+

Returns: ClusterModel

+
+

Protected unbindEvents#

+

▸ unbindEvents(): void

+

Defined in src/main/cluster.ts:346

+

internal

+

Returns: void

+
+

updateModel#

+

▸ updateModel(model: ClusterModel): void

+

Defined in src/main/cluster.ts:286

+

Update cluster data model

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
modelClusterModel
+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/v4.2.5/extensions/api/classes/_core_api_stores_.clusterstore/index.html new file mode 100644 index 0000000000..c66abe8471 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_core_api_stores_.clusterstore/index.html @@ -0,0 +1,1508 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:50

+

Get active cluster (a cluster which is currently visible)

+

deprecated use clusterStore.getById(workspaceStore.currentWorkspace.activeClusterId)

+

Returns: Cluster

+
+

activeClusterId#

+

• get activeClusterId(): string

+

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

+

Active cluster id

+

deprecated use workspaceStore.currentWorkspace.activeClusterId

+

Returns: string

+

• set activeClusterId(id: ClusterId): void

+

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

+

Set active cluster id

+

deprecated use LensExtension.navigate()

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idClusterId
+

Returns: void

+
+

clusters#

+

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

+

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

+

Map of all clusters

+

Returns: ObservableMap‹string, Cluster›

+
+

clustersList#

+

• get clustersList(): Cluster[]

+

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

+

Array of all clusters

+

Returns: Cluster[]

+
+

connectedClustersList#

+

• get connectedClustersList(): Cluster[]

+

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

+

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

+

Array of all enabled clusters

+

Returns: Cluster[]

+

Methods#

+

addCluster#

+

▸ addCluster(model: ClusterModel | Cluster): Cluster

+

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

+

Add a cluster to store

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
modelClusterModel | Clustercluster
+

Returns: Cluster

+
+

addClusters#

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Remove a cluster from store

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
modelClusterModelcluster
+

Returns: Promise‹void›

+
+

Static getInstance#

+

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

+

Inherited from ExtensionStore.getInstance

+

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

+

Type parameters:

+

▪ T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
...argsConstructorParameters‹Constructor‹T››
+

Returns: T

+
+

Static resetInstance#

+

▸ resetInstance(): void

+

Inherited from ExtensionStore.resetInstance

+

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

+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/v4.2.5/extensions/api/classes/_core_api_stores_.extensionstore/index.html new file mode 100644 index 0000000000..20e3b7d70e --- /dev/null +++ b/v4.2.5/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -0,0 +1,1696 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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 Optional 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:136

+

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

+

Returns: void

+
+

enableSync#

+

▸ enableSync(): void

+

Inherited from ExtensionStore.enableSync

+

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

+

Returns: void

+
+

Protected Abstract fromStore#

+

▸ fromStore(data: T): void

+

Inherited from ExtensionStore.fromStore

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
modelT
+

Returns: Promise‹void›

+
+

Protected onSync#

+

▸ onSync(model: T): void

+

Inherited from ExtensionStore.onSync

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
modelT
+

Returns: void

+
+

Protected onSyncFromMain#

+

▸ onSyncFromMain(model: T): void

+

Inherited from ExtensionStore.onSyncFromMain

+

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

+

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

+

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

+

It is recommended that a round trip is valid. Namely, calling +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:126

+

Returns: void

+
+

Static getInstance#

+

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

+

Inherited from ExtensionStore.getInstance

+

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

+

Type parameters:

+

▪ T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
...argsConstructorParameters‹Constructor‹T››
+

Returns: T

+
+

Static resetInstance#

+

▸ resetInstance(): void

+

Inherited from ExtensionStore.resetInstance

+

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

+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_core_api_stores_.workspace/index.html b/v4.2.5/extensions/api/classes/_core_api_stores_.workspace/index.html new file mode 100644 index 0000000000..65d1529c82 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_core_api_stores_.workspace/index.html @@ -0,0 +1,1562 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Workspace - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Workspace#

+

Workspace

+

beta

+

Hierarchy#

+
    +
  • Workspace
    • +
+

Implements#

+ +

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new Workspace(model: WorkspaceModel): Workspace

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
modelWorkspaceModel
+

Returns: Workspace

+

Properties#

+

#activeClusterId#

+

• #activeClusterId: IObservableValue‹string› = observable.box()

+

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

+

The active cluster within this workspace

+
+

[updateFromModel]#

+

• [updateFromModel]: (Anonymous function) & IAction = action((model: WorkspaceModel) => { + this.id = model.id; + this.name = model.name; + this.description = model.description; + this.ownerRef = model.ownerRef; + this.setActiveCluster(model.activeClusterId); + })

+

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

+
+

Optional description#

+

• description? : string

+

Implementation of WorkspaceModel.description

+

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

+

Workspace description

+

observable

+
+

id#

+

• id: WorkspaceId

+

Implementation of WorkspaceModel.id

+

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

+

Unique id for workspace

+

observable

+
+

name#

+

• name: string

+

Implementation of WorkspaceModel.name

+

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

+

Workspace name

+

observable

+
+

Optional ownerRef#

+

• ownerRef? : string

+

Implementation of WorkspaceModel.ownerRef

+

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

+

Workspace owner reference

+

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

+

observable

+

Accessors#

+

activeCluster#

+

• get activeCluster(): Cluster | undefined

+

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

+

Returns: Cluster | undefined

+
+

activeClusterId#

+

• get activeClusterId(): string

+

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

+

Returns: string

+
+

enabled#

+

• get enabled(): boolean

+

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

+

Is workspace enabled

+

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

+

computed

+

Returns: boolean

+

• set enabled(enabled: boolean): void

+

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

+

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

+

Is workspace managed by an extension

+

computed

+

Returns: boolean

+

Methods#

+

clearActiveCluster#

+

▸ clearActiveCluster(): void

+

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

+

Returns: void

+
+

getState#

+

▸ getState(): WorkspaceState

+

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

+

Get workspace state

+

Returns: WorkspaceState

+
+

pushState#

+

▸ pushState(state: WorkspaceState): void

+

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

+

Push state

+

internal

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
stateWorkspaceStatethis.getState()workspace state
+

Returns: void

+
+

setActiveCluster#

+

▸ setActiveCluster(clusterOrId?: ClusterId | Cluster): void

+

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

+

Sets workspace's active cluster to resolved clusterOrId. As long as it +is valid

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
clusterOrId?ClusterId | Clusterthe cluster instance or its ID
+

Returns: void

+
+

setState#

+

▸ setState(state: WorkspaceState): void

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
stateWorkspaceStateworkspace state
+

Returns: void

+
+

toJSON#

+

▸ toJSON(): WorkspaceModel

+

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

+

Returns: WorkspaceModel

+
+

tryClearAsActiveCluster#

+

▸ tryClearAsActiveCluster(clusterOrId: ClusterId | Cluster): boolean

+

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

+

Tries to clear the cluster as this workspace's activeCluster.

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
clusterOrIdClusterId | Clusterthe cluster instance or its ID
+

Returns: boolean

+

true if it matches the activeClusterId (and is thus cleared) else false

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/v4.2.5/extensions/api/classes/_core_api_stores_.workspacestore/index.html new file mode 100644 index 0000000000..79a74239f3 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_core_api_stores_.workspacestore/index.html @@ -0,0 +1,1560 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:18

+

Default workspace id, this workspace is always present

+

Accessors#

+

currentWorkspace#

+

• get currentWorkspace(): Workspace

+

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

+

Currently active workspace

+

Returns: Workspace

+
+

currentWorkspaceId#

+

• get currentWorkspaceId(): string

+

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

+

Currently active workspace id

+

Returns: string

+

• set currentWorkspaceId(id: string): void

+

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

+

Set active workspace id

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: void

+
+

enabledWorkspacesList#

+

• get enabledWorkspacesList(): Workspace[]

+

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

+

Array of all enabled (visible) workspaces

+

Returns: Workspace[]

+
+

workspaces#

+

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

+

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

+

Map of all workspaces

+

Returns: ObservableMap‹string, Workspace›

+
+

workspacesList#

+

• get workspacesList(): Workspace[]

+

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

+

Array of all workspaces

+

Returns: Workspace[]

+

Methods#

+

addWorkspace#

+

▸ addWorkspace(workspace: Workspace): Workspace‹›

+

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

+

Add a workspace to store

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
workspaceWorkspaceworkspace
+

Returns: Workspace‹›

+
+

getById#

+

▸ getById(id: WorkspaceId): Workspace

+

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

+

Get workspace by id

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
idWorkspaceIdworkspace id
+

Returns: Workspace

+
+

getByName#

+

▸ getByName(name: string): Workspace

+

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

+

Get workspace by name

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
namestringworkspace name
+

Returns: Workspace

+
+

removeWorkspace#

+

▸ removeWorkspace(workspace: Workspace): void

+

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

+

Remove workspace from store

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
workspaceWorkspaceworkspace
+

Returns: void

+
+

removeWorkspaceById#

+

▸ removeWorkspaceById(id: WorkspaceId): void

+

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

+

Remove workspace by id

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
idWorkspaceIdworkspace
+

Returns: void

+
+

setActive#

+

▸ setActive(id: string): void

+

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

+

Set active workspace

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
idstringWorkspaceStore.defaultIdworkspace id
+

Returns: void

+
+

setActiveCluster#

+

▸ setActiveCluster(clusterOrId: ClusterId | Cluster): Promise‹void›

+

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

+

Sets the cluster and its workspace as active

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
clusterOrIdClusterId | Clusterthe cluster's ID or instance to set as the active cluster
+

Returns: Promise‹void›

+
+

updateWorkspace#

+

▸ updateWorkspace(workspace: Workspace): void

+

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

+

Update a workspace in store

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDescription
workspaceWorkspaceworkspace
+

Returns: void

+
+

Static getInstance#

+

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

+

Inherited from ExtensionStore.getInstance

+

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

+

Type parameters:

+

▪ T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
...argsConstructorParameters‹Constructor‹T››
+

Returns: T

+
+

Static resetInstance#

+

▸ resetInstance(): void

+

Inherited from ExtensionStore.resetInstance

+

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

+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_core_api_utils_.singleton/index.html b/v4.2.5/extensions/api/classes/_core_api_utils_.singleton/index.html new file mode 100644 index 0000000000..a6d556dee3 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_core_api_utils_.singleton/index.html @@ -0,0 +1,1159 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Singleton - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Singleton#

+

Hierarchy#

+
    +
  • Singleton
    • +
+

↳ ClusterStore

+

↳ WorkspaceStore

+

Index#

+

Methods#

+ +

Methods#

+

Static getInstance#

+

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

+

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

+

Type parameters:

+

▪ T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
...argsConstructorParameters‹Constructor‹T››
+

Returns: T

+
+

Static resetInstance#

+

▸ resetInstance(): void

+

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

+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_components_.badge/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.badge/index.html new file mode 100644 index 0000000000..17ce077ea9 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.badge/index.html @@ -0,0 +1,1775 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.button/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.button/index.html new file mode 100644 index 0000000000..c7a3280ad4 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.button/index.html @@ -0,0 +1,1540 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/classes/_renderer_api_components_.checkbox/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.checkbox/index.html new file mode 100644 index 0000000000..98d70ed892 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.checkbox/index.html @@ -0,0 +1,1582 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html new file mode 100644 index 0000000000..2fd50bf183 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.commandoverlay/index.html @@ -0,0 +1,1155 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CommandOverlay - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html new file mode 100644 index 0000000000..d40f4f4994 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html @@ -0,0 +1,2034 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:33

+
+

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

+
+

Static params#

+

▪ params: ConfirmDialogParams

+

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

+

Accessors#

+

params#

+

• get params(): ConfirmDialogParams

+

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

+

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(): Promise‹void›

+

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

+

Returns: Promise‹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:62

+

Returns: Promise‹void›

+
+

onClose#

+

▸ onClose(): void

+

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

+

Returns: void

+
+

render#

+

▸ render(): Element‹›

+

Overrides void

+

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

+

Returns: Element‹›

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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 confirm#

+

▸ confirm(params: ConfirmDialogBooleanParams): Promise‹boolean›

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
paramsConfirmDialogBooleanParams
+

Returns: Promise‹boolean›

+
+

Static open#

+

▸ open(params: ConfirmDialogParams): void

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
paramsConfirmDialogParams
+

Returns: void

+

Object literals#

+

Static defaultParams#

+

▪ defaultParams: object#

+

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

+

cancel#

+

• cancel: any = noop

+

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

+

icon#

+

• icon: Element‹› =

+

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

+

labelCancel#

+

• labelCancel: string = "Cancel"

+

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

+

labelOk#

+

• labelOk: string = "Ok"

+

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

+

ok#

+

• ok: any = noop

+

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

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_components_.cubespinner/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.cubespinner/index.html new file mode 100644 index 0000000000..b9f5ee64ce --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -0,0 +1,1775 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.dialog/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.dialog/index.html new file mode 100644 index 0000000000..66a7527591 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -0,0 +1,1898 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/classes/_renderer_api_components_.drawer/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.drawer/index.html new file mode 100644 index 0000000000..dd8b8587c1 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -0,0 +1,1907 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.draweritem/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.draweritem/index.html new file mode 100644 index 0000000000..1b4acce160 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -0,0 +1,1775 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html new file mode 100644 index 0000000000..8f12ae5437 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -0,0 +1,1786 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.drawertitle/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.drawertitle/index.html new file mode 100644 index 0000000000..bc57baf28d --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -0,0 +1,1775 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.icon/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.icon/index.html new file mode 100644 index 0000000000..373642fd28 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -0,0 +1,1685 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/classes/_renderer_api_components_.input/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.input/index.html new file mode 100644 index 0000000000..321a7e3a71 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.input/index.html @@ -0,0 +1,2228 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html new file mode 100644 index 0000000000..4469180d88 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -0,0 +1,1774 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html new file mode 100644 index 0000000000..4493768de4 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -0,0 +1,1898 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:70

+
+

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

+
+

loadingError#

+

• loadingError: React.ReactNode

+

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

+
+

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

+

Returns: boolean

+
+

object#

+

• get object(): any

+

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

+

Returns: any

+
+

path#

+

• get path(): string

+

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

+

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

+

Returns: Element‹›

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html new file mode 100644 index 0000000000..71edffb008 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -0,0 +1,1838 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html new file mode 100644 index 0000000000..948aacee9c --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -0,0 +1,1876 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html new file mode 100644 index 0000000000..e9513a9e44 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -0,0 +1,1817 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.lineprogress/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.lineprogress/index.html new file mode 100644 index 0000000000..90ea93d12d --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -0,0 +1,1623 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/classes/_renderer_api_components_.menu/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.menu/index.html new file mode 100644 index 0000000000..36b16d4d87 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -0,0 +1,2183 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:125

+
+

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

+

Returns: MenuItem‹›[]

+
+

Protected focusedItem#

+

• get focusedItem(): MenuItem‹›

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemMenuItem
indexnumber
+

Returns: void

+
+

Protected bindRef#

+

▸ bindRef(elem: HTMLUListElement): void

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
elemHTMLUListElement
+

Returns: void

+
+

close#

+

▸ close(): void

+

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

+

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

+

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

+

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

+
+

onBlur#

+

▸ onBlur(): void

+

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

+

Returns: void

+
+

onClickOutside#

+

▸ onClickOutside(evt: MouseEvent): void

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
evtMouseEvent
+

Returns: void

+
+

onContextMenu#

+

▸ onContextMenu(): void

+

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

+

Returns: void

+
+

onKeyDown#

+

▸ onKeyDown(evt: KeyboardEvent): void

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
evtKeyboardEvent
+

Returns: void

+
+

onScrollOutside#

+

▸ onScrollOutside(evt: UIEvent): void

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
evtUIEvent
+

Returns: void

+
+

onWindowResize#

+

▸ onWindowResize(): void

+

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

+

Returns: void

+
+

open#

+

▸ open(): void

+

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

+

Returns: void

+
+

render#

+

▸ render(): Element‹›

+

Overrides void

+

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

+

Returns: Element‹›

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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:174

+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_components_.menuactions/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.menuactions/index.html new file mode 100644 index 0000000000..e2015106ab --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -0,0 +1,1890 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.menuitem/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.menuitem/index.html new file mode 100644 index 0000000000..0b5ddfdfa4 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -0,0 +1,1880 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:321

+
+

elem#

+

• elem: HTMLElement

+

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

+
+

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

+
+

Static defaultProps#

+

▪ defaultProps: object = defaultPropsMenuItem as object

+

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

+

Accessors#

+

isFocusable#

+

• get isFocusable(): boolean

+

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

+

Returns: boolean

+
+ +

• get isLink(): boolean

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
evtMouseEvent
+

Returns: void

+
+

render#

+

▸ render(): Element‹›

+

Overrides void

+

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

+

Returns: Element‹›

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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.2.5/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html new file mode 100644 index 0000000000..7f20ad1285 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.namespaceselect/index.html @@ -0,0 +1,1850 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:37

+

Accessors#

+

options#

+

• get options(): SelectOption[]

+

Defined in src/renderer/components/+namespaces/namespace-select.tsx:48

+

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

+

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

+

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

+

Returns: Element‹›

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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.2.5/extensions/api/classes/_renderer_api_components_.notifications/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.notifications/index.html new file mode 100644 index 0000000000..6d0dd7e613 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -0,0 +1,1928 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:42

+

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

+

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

+

Returns: Element‹›

+
+

scrollToLastNotification#

+

▸ scrollToLastNotification(): void

+

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

+

Returns: void

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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, customOpts: Partial‹Notification›): void

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
messageNotificationMessage-
customOptsPartial‹Notification›{}
+

Returns: void

+
+

Static info#

+

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

+

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

+

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.2.5/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html new file mode 100644 index 0000000000..7b47ae8e34 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -0,0 +1,1302 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/classes/_renderer_api_components_.pagelayout/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.pagelayout/index.html new file mode 100644 index 0000000000..18e96943b8 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -0,0 +1,1840 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:29

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
evtKeyboardEvent
+

Returns: void

+
+

render#

+

▸ render(): Element‹›

+

Overrides void

+

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

+

Returns: Element‹›

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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.2.5/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html new file mode 100644 index 0000000000..feace2ac1e --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.poddetailslist/index.html @@ -0,0 +1,1916 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.radio/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.radio/index.html new file mode 100644 index 0000000000..ae68213fae --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -0,0 +1,1816 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.radiogroup/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.radiogroup/index.html new file mode 100644 index 0000000000..c971fa00f1 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -0,0 +1,1773 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.select/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.select/index.html new file mode 100644 index 0000000000..79d8f89ff4 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.select/index.html @@ -0,0 +1,1997 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.slider/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.slider/index.html new file mode 100644 index 0000000000..bdfdc0f846 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -0,0 +1,1787 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.spinner/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.spinner/index.html new file mode 100644 index 0000000000..54965f5416 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -0,0 +1,1835 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:17

+

Returns: Element‹›

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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:12

+

center#

+

• center: boolean = false

+

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

+

singleColor#

+

• singleColor: boolean = true

+

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

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_components_.statusbrick/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.statusbrick/index.html new file mode 100644 index 0000000000..338b486cb9 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -0,0 +1,1775 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.stepper/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.stepper/index.html new file mode 100644 index 0000000000..3d79b75556 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -0,0 +1,1773 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.tab/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.tab/index.html new file mode 100644 index 0000000000..4ec6d44968 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -0,0 +1,1773 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/classes/_renderer_api_components_.table/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.table/index.html new file mode 100644 index 0000000000..fcdb966409 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.table/index.html @@ -0,0 +1,2017 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: Table ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: Table ‹S, SS, S›#

+

Type parameters#

+

▪ S

+

▪ SS

+

▪ S

+

Hierarchy#

+ +

↳ Table

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Object literals#

+ +

Constructors#

+

constructor#

+

+ new Table(props: Readonly‹TableProps› | 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
    • +
+
+

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#

+

sortParams#

+

• get sortParams(): object

+

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

+

Returns: 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‹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

+
+

componentDidMount#

+

▸ componentDidMount(): void

+

Overrides WizardLayout.componentDidMount

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemsany[]
+

Returns: any[]

+
+

Protected onSort#

+

▸ onSort(__namedParameters: object): void

+

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

+

Parameters:

+

▪ __namedParameters: object

+ + + + + + + + + + + + + + + + + +
NameType
orderBystring
sortBystring
+

Returns: void

+
+

render#

+

▸ render(): Element‹›

+

Overrides void

+

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

+

Returns: Element‹›

+
+

renderHead#

+

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

+

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

+

Returns: ReactElement‹TableHeadProps‹›, string | function | object›

+
+

renderRows#

+

▸ renderRows(): object

+

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

+

Returns: object

+
+

setState#

+

▸ setState‹K›(state: function | S | object, callback?: function): void

+

Inherited from PageLayout.setState

+

Defined in node_modules/@types/react/index.d.ts: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:136

+

Parameters:

+ + + + + + + + + + + + + +
NameType
colNameTableSortBy
+

Returns: void

+

Object literals#

+

Static defaultProps#

+

▪ defaultProps: object#

+

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

+

autoSize#

+

• autoSize: true = true

+

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

+

rowLineHeight#

+

• rowLineHeight: string = "17px"

+

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

+

rowPadding#

+

• rowPadding: string = "8px"

+

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

+

scrollable#

+

• scrollable: true = true

+

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

+

sortSyncWithUrl#

+

• sortSyncWithUrl: true = true

+

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

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_components_.tablecell/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.tablecell/index.html new file mode 100644 index 0000000000..658d3572a5 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -0,0 +1,1865 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.tablehead/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.tablehead/index.html new file mode 100644 index 0000000000..0aa33c4336 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -0,0 +1,1827 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.tablerow/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.tablerow/index.html new file mode 100644 index 0000000000..d832baeb18 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -0,0 +1,1775 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.tabs/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.tabs/index.html new file mode 100644 index 0000000000..0c5ed6fdb0 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -0,0 +1,1604 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/classes/_renderer_api_components_.tooltip/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.tooltip/index.html new file mode 100644 index 0000000000..2d7e0c5d27 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -0,0 +1,2019 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.wizard/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.wizard/index.html new file mode 100644 index 0000000000..93f177bbff --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.wizard/index.html @@ -0,0 +1,1986 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html new file mode 100644 index 0000000000..9d0d7a54f6 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -0,0 +1,1775 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_components_.wizardstep/index.html b/v4.2.5/extensions/api/classes/_renderer_api_components_.wizardstep/index.html new file mode 100644 index 0000000000..5dcac954fb --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_components_.wizardstep/index.html @@ -0,0 +1,1875 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ setState‹K›(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.2.5/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html new file mode 100644 index 0000000000..91da023459 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html @@ -0,0 +1,1893 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: ClusterRole

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

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

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html new file mode 100644 index 0000000000..e658fac9d1 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html @@ -0,0 +1,1932 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: ClusterRoleBinding

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html new file mode 100644 index 0000000000..a89341ad41 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html @@ -0,0 +1,1896 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:160

+
+

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

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

Optional status#

+

• status? : any

+

Inherited from KubeObject.status

+

Defined in src/renderer/api/kube-object.ts:163

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html new file mode 100644 index 0000000000..fcd63b4983 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMapsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ConfigMapsStore#

+

Hierarchy#

+

↳ KubeObjectStore‹ConfigMap›

+

↳ ConfigMapsStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new ConfigMapsStore(): ConfigMapsStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: ConfigMapsStore

+

Properties#

+

api#

+

• api: KubeApi‹ConfigMap‹›› = configMapApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+config-maps/config-maps.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: ConfigMap[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): ConfigMap[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemConfigMap
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: ConfigMap[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: ConfigMap): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemConfigMap
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: ConfigMap[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsConfigMap[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: ConfigMap): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemConfigMap
dataPartial‹ConfigMap›
+

Returns: Promise‹ConfigMap›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: ConfigMap, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: ConfigMap

+

▪ request: function

+

▸ (): Promise‹ConfigMap›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html new file mode 100644 index 0000000000..342859a5c0 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html @@ -0,0 +1,2540 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: T[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): T[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemT
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: T[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: T): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemT
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: T[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsT[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: T): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemT
dataPartial‹T›
+

Returns: Promise‹T›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: T, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: T

+

▪ request: function

+

▸ (): Promise‹T›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html new file mode 100644 index 0000000000..ddf0b6a8c0 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html @@ -0,0 +1,2577 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CRDStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CRDStore#

+

Hierarchy#

+

↳ KubeObjectStore‹CustomResourceDefinition›

+

↳ CRDStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new CRDStore(): CRDStore

+

Overrides KubeObjectStore.constructor

+

Defined in src/renderer/components/+custom-resources/crd.store.ts:23

+

Returns: CRDStore

+

Properties#

+

api#

+

• api: KubeApi‹CustomResourceDefinition‹›› = crdApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+custom-resources/crd.store.ts:23

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: CustomResourceDefinition[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): CustomResourceDefinition[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemCustomResourceDefinition
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: CustomResourceDefinition): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemCustomResourceDefinition
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsCustomResourceDefinition[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: CustomResourceDefinition): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemCustomResourceDefinition
dataPartial‹CustomResourceDefinition›
+

Returns: Promise‹CustomResourceDefinition›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: CustomResourceDefinition, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: CustomResourceDefinition

+

▪ request: function

+

▸ (): Promise‹CustomResourceDefinition›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html new file mode 100644 index 0000000000..a4fd9301f3 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html @@ -0,0 +1,2047 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

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

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

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

+

Returns: string[]

+
+

getSuspendFlag#

+

▸ getSuspendFlag(): string

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:99

+

Returns: string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html new file mode 100644 index 0000000000..8771265535 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html @@ -0,0 +1,2552 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: CronJobStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: CronJobStore#

+

Hierarchy#

+

↳ KubeObjectStore‹CronJob›

+

↳ CronJobStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new CronJobStore(): CronJobStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: CronJob[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): CronJob[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemCronJob
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: CronJob[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: CronJob): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemCronJob
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: CronJob[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsCronJob[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: CronJob): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemCronJob
dataPartial‹CronJob›
+

Returns: Promise‹CronJob›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: CronJob, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: CronJob

+

▪ request: function

+

▸ (): Promise‹CronJob›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html new file mode 100644 index 0000000000..c9790411f8 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html @@ -0,0 +1,2177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: CustomResourceDefinition

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

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

+

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

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

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

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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

+

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

+

Returns: string[]

+
+

getStoredVersions#

+

▸ getStoredVersions(): string

+

Defined in src/renderer/api/endpoints/crd.api.ts:113

+

Returns: string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html new file mode 100644 index 0000000000..64cb3a81aa --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html @@ -0,0 +1,2083 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: DaemonSet

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹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:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

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

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html new file mode 100644 index 0000000000..32aaf15741 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html @@ -0,0 +1,2595 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DaemonSetStore#

+

Hierarchy#

+

↳ KubeObjectStore‹DaemonSet›

+

↳ DaemonSetStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new DaemonSetStore(): DaemonSetStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: DaemonSetStore

+

Properties#

+

api#

+

• api: KubeApi‹DaemonSet‹›› = daemonSetApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: DaemonSet[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): DaemonSet[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemDaemonSet
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: DaemonSet[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: DaemonSet): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemDaemonSet
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: DaemonSet[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsDaemonSet[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: DaemonSet): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemDaemonSet
dataPartial‹DaemonSet›
+

Returns: Promise‹DaemonSet›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: DaemonSet, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: DaemonSet

+

▪ request: function

+

▸ (): Promise‹DaemonSet›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html new file mode 100644 index 0000000000..4da169e1f0 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html @@ -0,0 +1,2148 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Deployment

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹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:190

+

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

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

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

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html new file mode 100644 index 0000000000..966e4b8651 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html @@ -0,0 +1,2029 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:123

+

Parameters:

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions‹Deployment›
+

Returns: DeploymentApi

+

Properties#

+

apiBase#

+

• apiBase: string

+

Inherited from KubeApi.apiBase

+

Defined in src/renderer/api/kube-api.ts:112

+
+

apiGroup#

+

• apiGroup: string

+

Inherited from KubeApi.apiGroup

+

Defined in src/renderer/api/kube-api.ts:114

+
+

apiPrefix#

+

• apiPrefix: string

+

Inherited from KubeApi.apiPrefix

+

Defined in src/renderer/api/kube-api.ts:113

+
+

apiResource#

+

• apiResource: string

+

Inherited from KubeApi.apiResource

+

Defined in src/renderer/api/kube-api.ts:117

+
+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeApi.apiVersion

+

Defined in src/renderer/api/kube-api.ts:115

+
+

Optional apiVersionPreferred#

+

• apiVersionPreferred? : string

+

Inherited from KubeApi.apiVersionPreferred

+

Defined in src/renderer/api/kube-api.ts:116

+
+

isNamespaced#

+

• isNamespaced: boolean

+

Inherited from KubeApi.isNamespaced

+

Defined in src/renderer/api/kube-api.ts:118

+
+

kind#

+

• kind: string

+

Inherited from KubeApi.kind

+

Defined in src/renderer/api/kube-api.ts:111

+
+

objectConstructor#

+

• objectConstructor: IKubeObjectConstructor‹Deployment›

+

Inherited from KubeApi.objectConstructor

+

Defined in src/renderer/api/kube-api.ts:120

+
+

Protected options#

+

• options: IKubeApiOptions‹Deployment›

+

Inherited from KubeApi.options

+

Defined in src/renderer/api/kube-api.ts:125

+
+

Protected request#

+

• request: KubeJsonApi

+

Inherited from KubeApi.request

+

Defined in src/renderer/api/kube-api.ts:121

+
+

Protected resourceVersions#

+

• resourceVersions: Map‹string, string› = new Map()

+

Inherited from KubeApi.resourceVersions

+

Defined in src/renderer/api/kube-api.ts:122

+
+

Protected watchDisposer#

+

• watchDisposer: function

+

Inherited from KubeApi.watchDisposer

+

Defined in src/renderer/api/kube-api.ts:123

+

Type declaration:#

+

▸ (): void

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Inherited from KubeApi.apiVersionWithGroup

+

Defined in src/renderer/api/kube-api.ts:153

+

Returns: string

+

Methods#

+

Protected checkPreferredVersion#

+

▸ checkPreferredVersion(): Promise‹void›

+

Inherited from KubeApi.checkPreferredVersion

+

Defined in src/renderer/api/kube-api.ts:215

+

Returns: Promise‹void›

+
+

create#

+

▸ create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment | null›

+

Inherited from KubeApi.create

+

Defined in src/renderer/api/kube-api.ts:353

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹Deployment›

+

Returns: Promise‹Deployment | null›

+
+

delete#

+

▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

+

Inherited from KubeApi.delete

+

Defined in src/renderer/api/kube-api.ts:390

+

Parameters:

+

▪ __namedParameters: object

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

Returns: Promise‹KubeJsonApiData›

+
+

get#

+

▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment | null›

+

Inherited from KubeApi.get

+

Defined in src/renderer/api/kube-api.ts:339

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹Deployment | null›

+
+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
queryIKubeApiQueryParams{}
+

Returns: string

+
+

list#

+

▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment[] | null›

+

Inherited from KubeApi.list

+

Defined in src/renderer/api/kube-api.ts:321

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
reqInitRequestInit-
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹Deployment[] | null›

+
+

Protected modifyWatchEvent#

+

▸ modifyWatchEvent(event: IKubeWatchEvent): void

+

Inherited from KubeApi.modifyWatchEvent

+

Defined in src/renderer/api/kube-api.ts:462

+

Parameters:

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent
+

Returns: void

+
+

Protected normalizeQuery#

+

▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

+

Inherited from KubeApi.normalizeQuery

+

Defined in src/renderer/api/kube-api.ts:268

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
queryPartial‹IKubeApiQueryParams›{}
+

Returns: object

+
+

Protected parseResponse#

+

▸ parseResponse(data: unknown, namespace?: string): Deployment | Deployment[] | null

+

Inherited from KubeApi.parseResponse

+

Defined in src/renderer/api/kube-api.ts:280

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns: Deployment | Deployment[] | null

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?: KubeApiListOptions): Promise‹T[]›

+

Inherited from KubeApi.refreshResourceVersion

+

Defined in src/renderer/api/kube-api.ts:252

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns: Promise‹T[]›

+
+

restart#

+

▸ restart(params: object): Promise‹KubeJsonApiData›

+

Defined in src/renderer/api/endpoints/deployment.api.ts:29

+

Parameters:

+

▪ params: object

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespacestring
+

Returns: Promise‹KubeJsonApiData›

+
+

scale#

+

▸ scale(params: object, replicas: number): Promise‹KubeJsonApiData›

+

Defined in src/renderer/api/endpoints/deployment.api.ts:18

+

Parameters:

+

▪ params: object

+ + + + + + + + + + + + + + + + + +
NameType
namestring
namespacestring
+

▪ replicas: number

+

Returns: Promise‹KubeJsonApiData›

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace: string, newVersion: string): void

+

Inherited from KubeApi.setResourceVersion

+

Defined in src/renderer/api/kube-api.ts:244

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
newVersionstring-
+

Returns: void

+
+

update#

+

▸ update(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment | null›

+

Inherited from KubeApi.update

+

Defined in src/renderer/api/kube-api.ts:376

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹Deployment›

+

Returns: Promise‹Deployment | null›

+
+

watch#

+

▸ watch(opts: KubeApiWatchOptions): function

+

Inherited from KubeApi.watch

+

Defined in src/renderer/api/kube-api.ts:405

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
optsKubeApiWatchOptions{ namespace: "" }
+

Returns: function

+

▸ (): void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html new file mode 100644 index 0000000000..06bdbf4ab3 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html @@ -0,0 +1,2583 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: DeploymentStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Deployment›

+

↳ DeploymentStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new DeploymentStore(): DeploymentStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: Deployment[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Deployment[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemDeployment
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Deployment[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Deployment): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemDeployment
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Deployment[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsDeployment[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Deployment): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemDeployment
dataPartial‹Deployment›
+

Returns: Promise‹Deployment›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Deployment, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Deployment

+

▪ request: function

+

▸ (): Promise‹Deployment›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html new file mode 100644 index 0000000000..d4b8dc1ea1 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html @@ -0,0 +1,1905 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Endpoint

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

Optional status#

+

• status? : any

+

Inherited from KubeObject.status

+

Defined in src/renderer/api/kube-object.ts:163

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

toString#

+

▸ toString(): string

+

Defined in src/renderer/api/endpoints/endpoint.api.ts:117

+

Returns: string

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html new file mode 100644 index 0000000000..46939c5dd6 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: EndpointStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: EndpointStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Endpoint›

+

↳ EndpointStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new EndpointStore(): EndpointStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: EndpointStore

+

Properties#

+

api#

+

• api: KubeApi‹Endpoint‹›› = endpointApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: Endpoint[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Endpoint[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemEndpoint
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Endpoint[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Endpoint): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemEndpoint
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Endpoint[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsEndpoint[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Endpoint): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemEndpoint
dataPartial‹Endpoint›
+

Returns: Promise‹Endpoint›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Endpoint, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Endpoint

+

▪ request: function

+

▸ (): Promise‹Endpoint›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html new file mode 100644 index 0000000000..1870d743c0 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html @@ -0,0 +1,2553 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: EventStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: EventStore#

+

Hierarchy#

+

↳ KubeObjectStore‹KubeEvent›

+

↳ EventStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new EventStore(): EventStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: EventStore

+

Properties#

+

api#

+

• api: KubeApi‹KubeEvent‹›› = eventApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+events/event.store.ts:13

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: KubeEvent[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): KubeEvent[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeEvent
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: KubeEvent[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: KubeEvent): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeEvent
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: KubeEvent[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsKubeEvent[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: KubeEvent): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemKubeEvent
dataPartial‹KubeEvent›
+

Returns: Promise‹KubeEvent›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: KubeEvent, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: KubeEvent

+

▪ request: function

+

▸ (): Promise‹KubeEvent›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html new file mode 100644 index 0000000000..edda8e51cd --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html @@ -0,0 +1,2052 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: HorizontalPodAutoscaler

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

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

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html new file mode 100644 index 0000000000..8bf8447d7e --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: HPAStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: HPAStore#

+

Hierarchy#

+

↳ KubeObjectStore‹HorizontalPodAutoscaler›

+

↳ HPAStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new HPAStore(): HPAStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: HPAStore

+

Properties#

+

api#

+

• api: KubeApi‹HorizontalPodAutoscaler‹›› = hpaApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: HorizontalPodAutoscaler[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): HorizontalPodAutoscaler[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: HorizontalPodAutoscaler[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: HorizontalPodAutoscaler): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: HorizontalPodAutoscaler[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsHorizontalPodAutoscaler[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: HorizontalPodAutoscaler): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemHorizontalPodAutoscaler
dataPartial‹HorizontalPodAutoscaler›
+

Returns: Promise‹HorizontalPodAutoscaler›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: HorizontalPodAutoscaler, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: HorizontalPodAutoscaler

+

▪ request: function

+

▸ (): Promise‹HorizontalPodAutoscaler›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html new file mode 100644 index 0000000000..0704bccd94 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html @@ -0,0 +1,1976 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Ingress

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

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

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

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

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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

+

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

+

Returns: string[]

+
+

getServiceNamePort#

+

▸ getServiceNamePort(): object

+

Defined in src/renderer/api/endpoints/ingress.api.ts:126

+

Returns: object

+
    +
  • +

    serviceName: string

    +
    • +
  • +

    servicePort: string | number

    +
    • +
+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html new file mode 100644 index 0000000000..aa0139feda --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html @@ -0,0 +1,1928 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:123

+

Parameters:

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions‹Ingress›
+

Returns: IngressApi

+

Properties#

+

apiBase#

+

• apiBase: string

+

Inherited from KubeApi.apiBase

+

Defined in src/renderer/api/kube-api.ts:112

+
+

apiGroup#

+

• apiGroup: string

+

Inherited from KubeApi.apiGroup

+

Defined in src/renderer/api/kube-api.ts:114

+
+

apiPrefix#

+

• apiPrefix: string

+

Inherited from KubeApi.apiPrefix

+

Defined in src/renderer/api/kube-api.ts:113

+
+

apiResource#

+

• apiResource: string

+

Inherited from KubeApi.apiResource

+

Defined in src/renderer/api/kube-api.ts:117

+
+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeApi.apiVersion

+

Defined in src/renderer/api/kube-api.ts:115

+
+

Optional apiVersionPreferred#

+

• apiVersionPreferred? : string

+

Inherited from KubeApi.apiVersionPreferred

+

Defined in src/renderer/api/kube-api.ts:116

+
+

isNamespaced#

+

• isNamespaced: boolean

+

Inherited from KubeApi.isNamespaced

+

Defined in src/renderer/api/kube-api.ts:118

+
+

kind#

+

• kind: string

+

Inherited from KubeApi.kind

+

Defined in src/renderer/api/kube-api.ts:111

+
+

objectConstructor#

+

• objectConstructor: IKubeObjectConstructor‹Ingress›

+

Inherited from KubeApi.objectConstructor

+

Defined in src/renderer/api/kube-api.ts:120

+
+

Protected options#

+

• options: IKubeApiOptions‹Ingress›

+

Inherited from KubeApi.options

+

Defined in src/renderer/api/kube-api.ts:125

+
+

Protected request#

+

• request: KubeJsonApi

+

Inherited from KubeApi.request

+

Defined in src/renderer/api/kube-api.ts:121

+
+

Protected resourceVersions#

+

• resourceVersions: Map‹string, string› = new Map()

+

Inherited from KubeApi.resourceVersions

+

Defined in src/renderer/api/kube-api.ts:122

+
+

Protected watchDisposer#

+

• watchDisposer: function

+

Inherited from KubeApi.watchDisposer

+

Defined in src/renderer/api/kube-api.ts:123

+

Type declaration:#

+

▸ (): void

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Inherited from KubeApi.apiVersionWithGroup

+

Defined in src/renderer/api/kube-api.ts:153

+

Returns: string

+

Methods#

+

Protected checkPreferredVersion#

+

▸ checkPreferredVersion(): Promise‹void›

+

Inherited from KubeApi.checkPreferredVersion

+

Defined in src/renderer/api/kube-api.ts:215

+

Returns: Promise‹void›

+
+

create#

+

▸ create(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress | null›

+

Inherited from KubeApi.create

+

Defined in src/renderer/api/kube-api.ts:353

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹Ingress›

+

Returns: Promise‹Ingress | null›

+
+

delete#

+

▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

+

Inherited from KubeApi.delete

+

Defined in src/renderer/api/kube-api.ts:390

+

Parameters:

+

▪ __namedParameters: object

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

Returns: Promise‹KubeJsonApiData›

+
+

get#

+

▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress | null›

+

Inherited from KubeApi.get

+

Defined in src/renderer/api/kube-api.ts:339

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹Ingress | null›

+
+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
queryIKubeApiQueryParams{}
+

Returns: string

+
+

list#

+

▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress[] | null›

+

Inherited from KubeApi.list

+

Defined in src/renderer/api/kube-api.ts:321

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
reqInitRequestInit-
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹Ingress[] | null›

+
+

Protected modifyWatchEvent#

+

▸ modifyWatchEvent(event: IKubeWatchEvent): void

+

Inherited from KubeApi.modifyWatchEvent

+

Defined in src/renderer/api/kube-api.ts:462

+

Parameters:

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent
+

Returns: void

+
+

Protected normalizeQuery#

+

▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

+

Inherited from KubeApi.normalizeQuery

+

Defined in src/renderer/api/kube-api.ts:268

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
queryPartial‹IKubeApiQueryParams›{}
+

Returns: object

+
+

Protected parseResponse#

+

▸ parseResponse(data: unknown, namespace?: string): Ingress | Ingress[] | null

+

Inherited from KubeApi.parseResponse

+

Defined in src/renderer/api/kube-api.ts:280

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns: Ingress | Ingress[] | null

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?: KubeApiListOptions): Promise‹T[]›

+

Inherited from KubeApi.refreshResourceVersion

+

Defined in src/renderer/api/kube-api.ts:252

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns: Promise‹T[]›

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace: string, newVersion: string): void

+

Inherited from KubeApi.setResourceVersion

+

Defined in src/renderer/api/kube-api.ts:244

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
newVersionstring-
+

Returns: void

+
+

update#

+

▸ update(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress | null›

+

Inherited from KubeApi.update

+

Defined in src/renderer/api/kube-api.ts:376

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹Ingress›

+

Returns: Promise‹Ingress | null›

+
+

watch#

+

▸ watch(opts: KubeApiWatchOptions): function

+

Inherited from KubeApi.watch

+

Defined in src/renderer/api/kube-api.ts:405

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
optsKubeApiWatchOptions{ namespace: "" }
+

Returns: function

+

▸ (): void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html new file mode 100644 index 0000000000..67c6451fbc --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html @@ -0,0 +1,2556 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: IngressStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: IngressStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Ingress›

+

↳ IngressStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new IngressStore(): IngressStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: Ingress[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Ingress[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemIngress
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Ingress[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Ingress): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemIngress
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Ingress[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsIngress[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Ingress): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemIngress
dataPartial‹Ingress›
+

Returns: Promise‹Ingress›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Ingress, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Ingress

+

▪ request: function

+

▸ (): Promise‹Ingress›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.job/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.job/index.html new file mode 100644 index 0000000000..4c010f6bac --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.job/index.html @@ -0,0 +1,2134 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Job

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(): Promise‹KubeJsonApiData›

+

Overrides KubeObject.delete

+

Defined in src/renderer/api/endpoints/job.api.ts:101

+

Returns: Promise‹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:190

+

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

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

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

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html new file mode 100644 index 0000000000..561a61d4e5 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html @@ -0,0 +1,2586 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: JobStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: JobStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Job›

+

↳ JobStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new JobStore(): JobStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: JobStore

+

Properties#

+

api#

+

• api: KubeApi‹Job‹›› = jobApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+workloads-jobs/job.store.ts:10

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: Job[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Job[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemJob
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Job[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Job): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemJob
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Job[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsJob[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Job): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemJob
dataPartial‹Job›
+

Returns: Promise‹Job›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Job, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Job

+

▪ request: function

+

▸ (): Promise‹Job›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html new file mode 100644 index 0000000000..fefde66caa --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html @@ -0,0 +1,1879 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:123

+

Parameters:

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions‹T›
+

Returns: KubeApi

+

Properties#

+

apiBase#

+

• apiBase: string

+

Defined in src/renderer/api/kube-api.ts:112

+
+

apiGroup#

+

• apiGroup: string

+

Defined in src/renderer/api/kube-api.ts:114

+
+

apiPrefix#

+

• apiPrefix: string

+

Defined in src/renderer/api/kube-api.ts:113

+
+

apiResource#

+

• apiResource: string

+

Defined in src/renderer/api/kube-api.ts:117

+
+

apiVersion#

+

• apiVersion: string

+

Defined in src/renderer/api/kube-api.ts:115

+
+

Optional apiVersionPreferred#

+

• apiVersionPreferred? : string

+

Defined in src/renderer/api/kube-api.ts:116

+
+

isNamespaced#

+

• isNamespaced: boolean

+

Defined in src/renderer/api/kube-api.ts:118

+
+

kind#

+

• kind: string

+

Defined in src/renderer/api/kube-api.ts:111

+
+

objectConstructor#

+

• objectConstructor: IKubeObjectConstructor‹T›

+

Defined in src/renderer/api/kube-api.ts:120

+
+

Protected options#

+

• options: IKubeApiOptions‹T›

+

Defined in src/renderer/api/kube-api.ts:125

+
+

Protected request#

+

• request: KubeJsonApi

+

Defined in src/renderer/api/kube-api.ts:121

+
+

Protected resourceVersions#

+

• resourceVersions: Map‹string, string› = new Map()

+

Defined in src/renderer/api/kube-api.ts:122

+
+

Protected watchDisposer#

+

• watchDisposer: function

+

Defined in src/renderer/api/kube-api.ts:123

+

Type declaration:#

+

▸ (): void

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Defined in src/renderer/api/kube-api.ts:153

+

Returns: string

+

Methods#

+

Protected checkPreferredVersion#

+

▸ checkPreferredVersion(): Promise‹void›

+

Defined in src/renderer/api/kube-api.ts:215

+

Returns: Promise‹void›

+
+

create#

+

▸ create(__namedParameters: object, data?: Partial‹T›): Promise‹T | null›

+

Defined in src/renderer/api/kube-api.ts:353

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹T›

+

Returns: Promise‹T | null›

+
+

delete#

+

▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

+

Defined in src/renderer/api/kube-api.ts:390

+

Parameters:

+

▪ __namedParameters: object

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

Returns: Promise‹KubeJsonApiData›

+
+

get#

+

▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T | null›

+

Defined in src/renderer/api/kube-api.ts:339

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹T | null›

+
+

getResourceVersion#

+

▸ getResourceVersion(namespace: string): string

+

Defined in src/renderer/api/kube-api.ts:248

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
+

Returns: string

+
+

getUrl#

+

▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

+

Defined in src/renderer/api/kube-api.ts:256

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
queryIKubeApiQueryParams{}
+

Returns: string

+
+

list#

+

▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T[] | null›

+

Defined in src/renderer/api/kube-api.ts:321

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
reqInitRequestInit-
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹T[] | null›

+
+

Protected modifyWatchEvent#

+

▸ modifyWatchEvent(event: IKubeWatchEvent): void

+

Defined in src/renderer/api/kube-api.ts:462

+

Parameters:

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent
+

Returns: void

+
+

Protected normalizeQuery#

+

▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

+

Defined in src/renderer/api/kube-api.ts:268

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
queryPartial‹IKubeApiQueryParams›{}
+

Returns: object

+
+

Protected parseResponse#

+

▸ parseResponse(data: unknown, namespace?: string): T | T[] | null

+

Defined in src/renderer/api/kube-api.ts:280

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns: T | T[] | null

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?: KubeApiListOptions): Promise‹T[]›

+

Defined in src/renderer/api/kube-api.ts:252

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns: Promise‹T[]›

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace: string, newVersion: string): void

+

Defined in src/renderer/api/kube-api.ts:244

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
newVersionstring-
+

Returns: void

+
+

update#

+

▸ update(__namedParameters: object, data?: Partial‹T›): Promise‹T | null›

+

Defined in src/renderer/api/kube-api.ts:376

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹T›

+

Returns: Promise‹T | null›

+
+

watch#

+

▸ watch(opts: KubeApiWatchOptions): function

+

Defined in src/renderer/api/kube-api.ts:405

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
optsKubeApiWatchOptions{ namespace: "" }
+

Returns: function

+

▸ (): void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html new file mode 100644 index 0000000000..3aefb9aff6 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html @@ -0,0 +1,2084 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: KubeEvent

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

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

+
+

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

+
+

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

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

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

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

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

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getSource#

+

▸ getSource(): string

+

Defined in src/renderer/api/endpoints/events.api.ts:40

+

Returns: string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html new file mode 100644 index 0000000000..28996b774f --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html @@ -0,0 +1,1844 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: KubeObject

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

Optional status#

+

• status? : any

+

Defined in src/renderer/api/kube-object.ts:163

+
+

Static kind#

+

▪ kind: string

+

Defined in src/renderer/api/kube-object.ts:71

+
+

Static namespaced#

+

▪ namespaced: boolean

+

Defined in src/renderer/api/kube-object.ts:72

+

Accessors#

+ +

• get selfLink(): string

+

Defined in src/renderer/api/kube-object.ts:165

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Defined in src/renderer/api/kube-object.ts:190

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
humanizebooleantrue
compactbooleantrue
fromNowbooleanfalse
+

Returns: string | number

+
+

getAnnotations#

+

▸ getAnnotations(filter: boolean): string[]

+

Defined in src/renderer/api/kube-object.ts:211

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html new file mode 100644 index 0000000000..506f8f17a6 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html @@ -0,0 +1,2520 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: T[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Defined in src/renderer/kube-object.store.ts:265

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
delaynumber1000
+

Returns: void

+
+

create#

+

▸ create(params: object, data?: Partial‹T›): Promise‹T›

+

Defined in src/renderer/kube-object.store.ts:234

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): T[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemT
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: T[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsT[]this.items
+

Returns: boolean

+
+

load#

+

▸ load(params: object): Promise‹T›

+

Defined in src/renderer/kube-object.store.ts:209

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
resourcePathstring
+

Returns: Promise‹T›

+
+

Protected loadItem#

+

▸ loadItem(params: object): Promise‹T›

+

Overrides void

+

Defined in src/renderer/kube-object.store.ts:204

+

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

+

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

+

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

+

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

+

Parameters:

+

▪ item: T

+

▪ request: function

+

▸ (): Promise‹any›

+

Returns: Promise‹void›

+
+

removeSelectedItems#

+

▸ removeSelectedItems(): Promise‹void[]›

+

Overrides void

+

Defined in src/renderer/kube-object.store.ts:258

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: T): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemT
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: T[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsT[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: T): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemT
+

Returns: void

+
+

update#

+

▸ update(item: T, data: Partial‹T›): Promise‹T›

+

Defined in src/renderer/kube-object.store.ts:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemT
dataPartial‹T›
+

Returns: Promise‹T›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: T, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: T

+

▪ request: function

+

▸ (): Promise‹T›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html new file mode 100644 index 0000000000..37dbed3fdd --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.limitrange/index.html @@ -0,0 +1,1922 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: LimitRange

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html new file mode 100644 index 0000000000..3c23c51d7c --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.limitrangesstore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: LimitRangesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: LimitRangesStore#

+

Hierarchy#

+

↳ KubeObjectStore‹LimitRange›

+

↳ 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: KubeApi‹LimitRange‹›› = 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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: LimitRange[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): LimitRange[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemLimitRange
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: LimitRange[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: LimitRange): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemLimitRange
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: LimitRange[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsLimitRange[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: LimitRange): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemLimitRange
dataPartial‹LimitRange›
+

Returns: Promise‹LimitRange›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: LimitRange, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: LimitRange

+

▪ request: function

+

▸ (): Promise‹LimitRange›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html new file mode 100644 index 0000000000..ac3f18ca45 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html @@ -0,0 +1,1884 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Namespace

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getStatus#

+

▸ getStatus(): string

+

Defined in src/renderer/api/endpoints/namespaces.api.ts:20

+

Returns: string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html new file mode 100644 index 0000000000..68883d72f3 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html @@ -0,0 +1,2706 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NamespaceStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Namespace›

+

↳ NamespaceStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new NamespaceStore(): NamespaceStore

+

Overrides KubeObjectStore.constructor

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:34

+

Returns: NamespaceStore

+

Properties#

+

api#

+

• api: KubeApi‹Namespace‹›› = namespacesApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:32

+
+

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

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

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

+

Returns: string[]

+
+

hasAllContexts#

+

• get hasAllContexts(): boolean

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:148

+

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

+

Returns: Namespace[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Namespace[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
namespacesstring | string[]
+

Returns: boolean

+
+

isSelected#

+

▸ isSelected(item: Namespace): boolean

+

Inherited from KubeObjectStore.isSelected

+

Defined in src/renderer/item.store.ts:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemNamespace
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Namespace[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

resetContext#

+

▸ resetContext(): void

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:140

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Namespace): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemNamespace
+

Returns: void

+
+

setContext#

+

▸ setContext(namespace: string | string[]): void

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:133

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
apisKubeApi‹any›[]this.getSubscribeApis()
+

Returns: (Anonymous function)

+
+

toggleAll#

+

▸ toggleAll(showAll?: boolean): void

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:162

+

Parameters:

+ + + + + + + + + + + + + +
NameType
showAll?boolean
+

Returns: void

+
+

toggleContext#

+

▸ toggleContext(namespace: string): void

+

Defined in src/renderer/components/+namespaces/namespace.store.ts:153

+

Parameters:

+ + + + + + + + + + + + + +
NameType
namespacestring
+

Returns: void

+
+

toggleSelection#

+

▸ toggleSelection(item: Namespace): void

+

Inherited from KubeObjectStore.toggleSelection

+

Defined in src/renderer/item.store.ts:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemNamespace
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Namespace[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsNamespace[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Namespace): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemNamespace
dataPartial‹Namespace›
+

Returns: Promise‹Namespace›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Namespace, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Namespace

+

▪ request: function

+

▸ (): Promise‹Namespace›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html new file mode 100644 index 0000000000..c2796ae6e3 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html @@ -0,0 +1,1926 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: NetworkPolicy

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

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

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html new file mode 100644 index 0000000000..1faf42e282 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicyStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NetworkPolicyStore#

+

Hierarchy#

+

↳ KubeObjectStore‹NetworkPolicy›

+

↳ NetworkPolicyStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new NetworkPolicyStore(): NetworkPolicyStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: NetworkPolicyStore

+

Properties#

+

api#

+

• api: KubeApi‹NetworkPolicy‹›› = networkPolicyApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+network-policies/network-policy.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: NetworkPolicy[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): NetworkPolicy[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemNetworkPolicy
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: NetworkPolicy[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: NetworkPolicy): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemNetworkPolicy
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: NetworkPolicy[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsNetworkPolicy[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: NetworkPolicy): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemNetworkPolicy
dataPartial‹NetworkPolicy›
+

Returns: Promise‹NetworkPolicy›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: NetworkPolicy, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: NetworkPolicy

+

▪ request: function

+

▸ (): Promise‹NetworkPolicy›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.node/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.node/index.html new file mode 100644 index 0000000000..d429142a8d --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.node/index.html @@ -0,0 +1,2106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Node

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹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:190

+

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

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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

+

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

+

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

+

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

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

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

+

Returns: string[]

+
+

getTaints#

+

▸ getTaints(): object[]

+

Defined in src/renderer/api/endpoints/nodes.api.ts:100

+

Returns: object[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html new file mode 100644 index 0000000000..d2707e0b3c --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html @@ -0,0 +1,1909 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:123

+

Parameters:

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions‹Node›
+

Returns: NodesApi

+

Properties#

+

apiBase#

+

• apiBase: string

+

Inherited from KubeApi.apiBase

+

Defined in src/renderer/api/kube-api.ts:112

+
+

apiGroup#

+

• apiGroup: string

+

Inherited from KubeApi.apiGroup

+

Defined in src/renderer/api/kube-api.ts:114

+
+

apiPrefix#

+

• apiPrefix: string

+

Inherited from KubeApi.apiPrefix

+

Defined in src/renderer/api/kube-api.ts:113

+
+

apiResource#

+

• apiResource: string

+

Inherited from KubeApi.apiResource

+

Defined in src/renderer/api/kube-api.ts:117

+
+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeApi.apiVersion

+

Defined in src/renderer/api/kube-api.ts:115

+
+

Optional apiVersionPreferred#

+

• apiVersionPreferred? : string

+

Inherited from KubeApi.apiVersionPreferred

+

Defined in src/renderer/api/kube-api.ts:116

+
+

isNamespaced#

+

• isNamespaced: boolean

+

Inherited from KubeApi.isNamespaced

+

Defined in src/renderer/api/kube-api.ts:118

+
+

kind#

+

• kind: string

+

Inherited from KubeApi.kind

+

Defined in src/renderer/api/kube-api.ts:111

+
+

objectConstructor#

+

• objectConstructor: IKubeObjectConstructor‹Node›

+

Inherited from KubeApi.objectConstructor

+

Defined in src/renderer/api/kube-api.ts:120

+
+

Protected options#

+

• options: IKubeApiOptions‹Node›

+

Inherited from KubeApi.options

+

Defined in src/renderer/api/kube-api.ts:125

+
+

Protected request#

+

• request: KubeJsonApi

+

Inherited from KubeApi.request

+

Defined in src/renderer/api/kube-api.ts:121

+
+

Protected resourceVersions#

+

• resourceVersions: Map‹string, string› = new Map()

+

Inherited from KubeApi.resourceVersions

+

Defined in src/renderer/api/kube-api.ts:122

+
+

Protected watchDisposer#

+

• watchDisposer: function

+

Inherited from KubeApi.watchDisposer

+

Defined in src/renderer/api/kube-api.ts:123

+

Type declaration:#

+

▸ (): void

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Inherited from KubeApi.apiVersionWithGroup

+

Defined in src/renderer/api/kube-api.ts:153

+

Returns: string

+

Methods#

+

Protected checkPreferredVersion#

+

▸ checkPreferredVersion(): Promise‹void›

+

Inherited from KubeApi.checkPreferredVersion

+

Defined in src/renderer/api/kube-api.ts:215

+

Returns: Promise‹void›

+
+

create#

+

▸ create(__namedParameters: object, data?: Partial‹Node›): Promise‹Node | null›

+

Inherited from KubeApi.create

+

Defined in src/renderer/api/kube-api.ts:353

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹Node›

+

Returns: Promise‹Node | null›

+
+

delete#

+

▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

+

Inherited from KubeApi.delete

+

Defined in src/renderer/api/kube-api.ts:390

+

Parameters:

+

▪ __namedParameters: object

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

Returns: Promise‹KubeJsonApiData›

+
+

get#

+

▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node | null›

+

Inherited from KubeApi.get

+

Defined in src/renderer/api/kube-api.ts:339

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹Node | null›

+
+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
queryIKubeApiQueryParams{}
+

Returns: string

+
+

list#

+

▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node[] | null›

+

Inherited from KubeApi.list

+

Defined in src/renderer/api/kube-api.ts:321

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
reqInitRequestInit-
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹Node[] | null›

+
+

Protected modifyWatchEvent#

+

▸ modifyWatchEvent(event: IKubeWatchEvent): void

+

Inherited from KubeApi.modifyWatchEvent

+

Defined in src/renderer/api/kube-api.ts:462

+

Parameters:

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent
+

Returns: void

+
+

Protected normalizeQuery#

+

▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

+

Inherited from KubeApi.normalizeQuery

+

Defined in src/renderer/api/kube-api.ts:268

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
queryPartial‹IKubeApiQueryParams›{}
+

Returns: object

+
+

Protected parseResponse#

+

▸ parseResponse(data: unknown, namespace?: string): Node | Node[] | null

+

Inherited from KubeApi.parseResponse

+

Defined in src/renderer/api/kube-api.ts:280

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns: Node | Node[] | null

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?: KubeApiListOptions): Promise‹T[]›

+

Inherited from KubeApi.refreshResourceVersion

+

Defined in src/renderer/api/kube-api.ts:252

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns: Promise‹T[]›

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace: string, newVersion: string): void

+

Inherited from KubeApi.setResourceVersion

+

Defined in src/renderer/api/kube-api.ts:244

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
newVersionstring-
+

Returns: void

+
+

update#

+

▸ update(__namedParameters: object, data?: Partial‹Node›): Promise‹Node | null›

+

Inherited from KubeApi.update

+

Defined in src/renderer/api/kube-api.ts:376

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹Node›

+

Returns: Promise‹Node | null›

+
+

watch#

+

▸ watch(opts: KubeApiWatchOptions): function

+

Inherited from KubeApi.watch

+

Defined in src/renderer/api/kube-api.ts:405

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
optsKubeApiWatchOptions{ namespace: "" }
+

Returns: function

+

▸ (): void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html new file mode 100644 index 0000000000..75bdf624a9 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html @@ -0,0 +1,2676 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: NodesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: NodesStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Node›

+

↳ NodesStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new NodesStore(): NodesStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

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

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Node[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemNode
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Node[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Node): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemNode
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Node[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsNode[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Node): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemNode
dataPartial‹Node›
+

Returns: Promise‹Node›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Node, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Node

+

▪ request: function

+

▸ (): Promise‹Node›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html new file mode 100644 index 0000000000..a46babdb60 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html @@ -0,0 +1,2044 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: PersistentVolume

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

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

+

Returns: string

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getStatus#

+

▸ getStatus(): string

+

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

+

Returns: string

+
+

getStorageClass#

+

▸ getStorageClass(): string

+

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

+

Returns: string

+
+

getStorageClassName#

+

▸ getStorageClassName(): string

+

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:74

+

Returns: string

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html new file mode 100644 index 0000000000..df70c4cd9d --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html @@ -0,0 +1,1993 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: PersistentVolumeClaim

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

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

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html new file mode 100644 index 0000000000..27618b2526 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html @@ -0,0 +1,1928 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:123

+

Parameters:

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions‹PersistentVolumeClaim›
+

Returns: PersistentVolumeClaimsApi

+

Properties#

+

apiBase#

+

• apiBase: string

+

Inherited from KubeApi.apiBase

+

Defined in src/renderer/api/kube-api.ts:112

+
+

apiGroup#

+

• apiGroup: string

+

Inherited from KubeApi.apiGroup

+

Defined in src/renderer/api/kube-api.ts:114

+
+

apiPrefix#

+

• apiPrefix: string

+

Inherited from KubeApi.apiPrefix

+

Defined in src/renderer/api/kube-api.ts:113

+
+

apiResource#

+

• apiResource: string

+

Inherited from KubeApi.apiResource

+

Defined in src/renderer/api/kube-api.ts:117

+
+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeApi.apiVersion

+

Defined in src/renderer/api/kube-api.ts:115

+
+

Optional apiVersionPreferred#

+

• apiVersionPreferred? : string

+

Inherited from KubeApi.apiVersionPreferred

+

Defined in src/renderer/api/kube-api.ts:116

+
+

isNamespaced#

+

• isNamespaced: boolean

+

Inherited from KubeApi.isNamespaced

+

Defined in src/renderer/api/kube-api.ts:118

+
+

kind#

+

• kind: string

+

Inherited from KubeApi.kind

+

Defined in src/renderer/api/kube-api.ts:111

+
+

objectConstructor#

+

• objectConstructor: IKubeObjectConstructor‹PersistentVolumeClaim›

+

Inherited from KubeApi.objectConstructor

+

Defined in src/renderer/api/kube-api.ts:120

+
+

Protected options#

+

• options: IKubeApiOptions‹PersistentVolumeClaim›

+

Inherited from KubeApi.options

+

Defined in src/renderer/api/kube-api.ts:125

+
+

Protected request#

+

• request: KubeJsonApi

+

Inherited from KubeApi.request

+

Defined in src/renderer/api/kube-api.ts:121

+
+

Protected resourceVersions#

+

• resourceVersions: Map‹string, string› = new Map()

+

Inherited from KubeApi.resourceVersions

+

Defined in src/renderer/api/kube-api.ts:122

+
+

Protected watchDisposer#

+

• watchDisposer: function

+

Inherited from KubeApi.watchDisposer

+

Defined in src/renderer/api/kube-api.ts:123

+

Type declaration:#

+

▸ (): void

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Inherited from KubeApi.apiVersionWithGroup

+

Defined in src/renderer/api/kube-api.ts:153

+

Returns: string

+

Methods#

+

Protected checkPreferredVersion#

+

▸ checkPreferredVersion(): Promise‹void›

+

Inherited from KubeApi.checkPreferredVersion

+

Defined in src/renderer/api/kube-api.ts:215

+

Returns: Promise‹void›

+
+

create#

+

▸ create(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim | null›

+

Inherited from KubeApi.create

+

Defined in src/renderer/api/kube-api.ts:353

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹PersistentVolumeClaim›

+

Returns: Promise‹PersistentVolumeClaim | null›

+
+

delete#

+

▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

+

Inherited from KubeApi.delete

+

Defined in src/renderer/api/kube-api.ts:390

+

Parameters:

+

▪ __namedParameters: object

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

Returns: Promise‹KubeJsonApiData›

+
+

get#

+

▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim | null›

+

Inherited from KubeApi.get

+

Defined in src/renderer/api/kube-api.ts:339

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹PersistentVolumeClaim | null›

+
+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
queryIKubeApiQueryParams{}
+

Returns: string

+
+

list#

+

▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim[] | null›

+

Inherited from KubeApi.list

+

Defined in src/renderer/api/kube-api.ts:321

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
reqInitRequestInit-
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹PersistentVolumeClaim[] | null›

+
+

Protected modifyWatchEvent#

+

▸ modifyWatchEvent(event: IKubeWatchEvent): void

+

Inherited from KubeApi.modifyWatchEvent

+

Defined in src/renderer/api/kube-api.ts:462

+

Parameters:

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent
+

Returns: void

+
+

Protected normalizeQuery#

+

▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

+

Inherited from KubeApi.normalizeQuery

+

Defined in src/renderer/api/kube-api.ts:268

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
queryPartial‹IKubeApiQueryParams›{}
+

Returns: object

+
+

Protected parseResponse#

+

▸ parseResponse(data: unknown, namespace?: string): PersistentVolumeClaim | PersistentVolumeClaim[] | null

+

Inherited from KubeApi.parseResponse

+

Defined in src/renderer/api/kube-api.ts:280

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns: PersistentVolumeClaim | PersistentVolumeClaim[] | null

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?: KubeApiListOptions): Promise‹T[]›

+

Inherited from KubeApi.refreshResourceVersion

+

Defined in src/renderer/api/kube-api.ts:252

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns: Promise‹T[]›

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace: string, newVersion: string): void

+

Inherited from KubeApi.setResourceVersion

+

Defined in src/renderer/api/kube-api.ts:244

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
newVersionstring-
+

Returns: void

+
+

update#

+

▸ update(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim | null›

+

Inherited from KubeApi.update

+

Defined in src/renderer/api/kube-api.ts:376

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹PersistentVolumeClaim›

+

Returns: Promise‹PersistentVolumeClaim | null›

+
+

watch#

+

▸ watch(opts: KubeApiWatchOptions): function

+

Inherited from KubeApi.watch

+

Defined in src/renderer/api/kube-api.ts:405

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
optsKubeApiWatchOptions{ namespace: "" }
+

Returns: function

+

▸ (): void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html new file mode 100644 index 0000000000..8e968e3f72 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html @@ -0,0 +1,2544 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PersistentVolumesStore#

+

Hierarchy#

+

↳ KubeObjectStore‹PersistentVolume›

+

↳ PersistentVolumesStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new PersistentVolumesStore(): PersistentVolumesStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: PersistentVolumesStore

+

Properties#

+

api#

+

• api: KubeApi‹PersistentVolume‹›› = persistentVolumeApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+storage-volumes/volumes.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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: PersistentVolume[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+
+

getByStorageClass#

+

▸ getByStorageClass(storageClass: StorageClass): PersistentVolume[]

+

Defined in src/renderer/components/+storage-volumes/volumes.store.ts:11

+

Parameters:

+ + + + + + + + + + + + + +
NameType
storageClassStorageClass
+

Returns: PersistentVolume[]

+
+

getIndexById#

+

▸ getIndexById(id: string): number

+

Inherited from KubeObjectStore.getIndexById

+

Defined in src/renderer/item.store.ts:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): PersistentVolume[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemPersistentVolume
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: PersistentVolume[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: PersistentVolume): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemPersistentVolume
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: PersistentVolume[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsPersistentVolume[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: PersistentVolume): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolume
dataPartial‹PersistentVolume›
+

Returns: Promise‹PersistentVolume›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: PersistentVolume, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: PersistentVolume

+

▪ request: function

+

▸ (): Promise‹PersistentVolume›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html new file mode 100644 index 0000000000..e568c887b1 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html @@ -0,0 +1,2444 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Pod

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAffinity#

+

▸ getAffinity(): IAffinity

+

Overrides Deployment.getAffinity

+

Defined in src/renderer/api/endpoints/pods.api.ts:390

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getConditions#

+

▸ getConditions(): object[]

+

Defined in src/renderer/api/endpoints/pods.api.ts:366

+

Returns: object[]

+
+

getContainerStatuses#

+

▸ getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

+

Defined in src/renderer/api/endpoints/pods.api.ts:287

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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

+

Returns: string[]

+
+

getLivenessProbe#

+

▸ getLivenessProbe(container: IPodContainer): string[]

+

Defined in src/renderer/api/endpoints/pods.api.ts:410

+

Parameters:

+ + + + + + + + + + + + + +
NameType
containerIPodContainer
+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNodeName#

+

▸ getNodeName(): string

+

Defined in src/renderer/api/endpoints/pods.api.ts:460

+

Returns: string

+
+

getNodeSelectors#

+

▸ getNodeSelectors(): string[]

+

Overrides Deployment.getNodeSelectors

+

Defined in src/renderer/api/endpoints/pods.api.ts:380

+

Returns: string[]

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getPriorityClassName#

+

▸ getPriorityClassName(): string

+

Defined in src/renderer/api/endpoints/pods.api.ts:311

+

Returns: string

+
+

getProbe#

+

▸ getProbe(probeData: IContainerProbe): string[]

+

Defined in src/renderer/api/endpoints/pods.api.ts:422

+

Parameters:

+ + + + + + + + + + + + + +
NameType
probeDataIContainerProbe
+

Returns: string[]

+
+

getQosClass#

+

▸ getQosClass(): string

+

Defined in src/renderer/api/endpoints/pods.api.ts:303

+

Returns: string

+
+

getReadinessProbe#

+

▸ getReadinessProbe(container: IPodContainer): string[]

+

Defined in src/renderer/api/endpoints/pods.api.ts:414

+

Parameters:

+ + + + + + + + + + + + + +
NameType
containerIPodContainer
+

Returns: string[]

+
+

getReason#

+

▸ getReason(): string

+

Defined in src/renderer/api/endpoints/pods.api.ts:307

+

Returns: string

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getRestartsCount#

+

▸ getRestartsCount(): number

+

Defined in src/renderer/api/endpoints/pods.api.ts:297

+

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

+

Returns: string[]

+
+

getSecrets#

+

▸ getSecrets(): string[]

+

Defined in src/renderer/api/endpoints/pods.api.ts:374

+

Returns: string[]

+
+

getSelectedNodeOs#

+

▸ getSelectedNodeOs(): string | undefined

+

Defined in src/renderer/api/endpoints/pods.api.ts:464

+

Returns: string | undefined

+
+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
containerIPodContainer
+

Returns: string[]

+
+

getStatus#

+

▸ getStatus(): PodStatus

+

Defined in src/renderer/api/endpoints/pods.api.ts:315

+

Returns: PodStatus

+
+

getStatusMessage#

+

▸ getStatusMessage(): string

+

Defined in src/renderer/api/endpoints/pods.api.ts:343

+

Returns: string

+
+

getStatusPhase#

+

▸ getStatusPhase(): string

+

Defined in src/renderer/api/endpoints/pods.api.ts:362

+

Returns: string

+
+

getTemplateLabels#

+

▸ getTemplateLabels(): string[]

+

Inherited from Pod.getTemplateLabels

+

Defined in src/renderer/api/workload-kube-object.ts:64

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

getTolerations#

+

▸ getTolerations(): object[]

+

Overrides Deployment.getTolerations

+

Defined in src/renderer/api/endpoints/pods.api.ts:386

+

Returns: object[]

+
+

getVolumes#

+

▸ getVolumes(): object[]

+

Defined in src/renderer/api/endpoints/pods.api.ts:370

+

Returns: object[]

+
+

hasIssues#

+

▸ hasIssues(): boolean

+

Defined in src/renderer/api/endpoints/pods.api.ts:394

+

Returns: boolean

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html new file mode 100644 index 0000000000..08983cdd45 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html @@ -0,0 +1,1974 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: PodDisruptionBudget

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

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

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getSelectors#

+

▸ getSelectors(): string[]

+

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html new file mode 100644 index 0000000000..26e5bd97e4 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudgetsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PodDisruptionBudgetsStore#

+

Hierarchy#

+

↳ KubeObjectStore‹PodDisruptionBudget›

+

↳ PodDisruptionBudgetsStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new PodDisruptionBudgetsStore(): PodDisruptionBudgetsStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: PodDisruptionBudgetsStore

+

Properties#

+

api#

+

• api: KubeApi‹PodDisruptionBudget‹›› = pdbApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: PodDisruptionBudget[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): PodDisruptionBudget[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: PodDisruptionBudget[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: PodDisruptionBudget): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: PodDisruptionBudget[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsPodDisruptionBudget[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: PodDisruptionBudget): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemPodDisruptionBudget
dataPartial‹PodDisruptionBudget›
+

Returns: Promise‹PodDisruptionBudget›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: PodDisruptionBudget, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: PodDisruptionBudget

+

▪ request: function

+

▸ (): Promise‹PodDisruptionBudget›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html new file mode 100644 index 0000000000..5d30de5b0f --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html @@ -0,0 +1,1970 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:123

+

Parameters:

+ + + + + + + + + + + + + +
NameType
optionsIKubeApiOptions‹Pod›
+

Returns: PodsApi

+

Properties#

+

apiBase#

+

• apiBase: string

+

Inherited from KubeApi.apiBase

+

Defined in src/renderer/api/kube-api.ts:112

+
+

apiGroup#

+

• apiGroup: string

+

Inherited from KubeApi.apiGroup

+

Defined in src/renderer/api/kube-api.ts:114

+
+

apiPrefix#

+

• apiPrefix: string

+

Inherited from KubeApi.apiPrefix

+

Defined in src/renderer/api/kube-api.ts:113

+
+

apiResource#

+

• apiResource: string

+

Inherited from KubeApi.apiResource

+

Defined in src/renderer/api/kube-api.ts:117

+
+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeApi.apiVersion

+

Defined in src/renderer/api/kube-api.ts:115

+
+

Optional apiVersionPreferred#

+

• apiVersionPreferred? : string

+

Inherited from KubeApi.apiVersionPreferred

+

Defined in src/renderer/api/kube-api.ts:116

+
+

isNamespaced#

+

• isNamespaced: boolean

+

Inherited from KubeApi.isNamespaced

+

Defined in src/renderer/api/kube-api.ts:118

+
+

kind#

+

• kind: string

+

Inherited from KubeApi.kind

+

Defined in src/renderer/api/kube-api.ts:111

+
+

objectConstructor#

+

• objectConstructor: IKubeObjectConstructor‹Pod›

+

Inherited from KubeApi.objectConstructor

+

Defined in src/renderer/api/kube-api.ts:120

+
+

Protected options#

+

• options: IKubeApiOptions‹Pod›

+

Inherited from KubeApi.options

+

Defined in src/renderer/api/kube-api.ts:125

+
+

Protected request#

+

• request: KubeJsonApi

+

Inherited from KubeApi.request

+

Defined in src/renderer/api/kube-api.ts:121

+
+

Protected resourceVersions#

+

• resourceVersions: Map‹string, string› = new Map()

+

Inherited from KubeApi.resourceVersions

+

Defined in src/renderer/api/kube-api.ts:122

+
+

Protected watchDisposer#

+

• watchDisposer: function

+

Inherited from KubeApi.watchDisposer

+

Defined in src/renderer/api/kube-api.ts:123

+

Type declaration:#

+

▸ (): void

+

Accessors#

+

apiVersionWithGroup#

+

• get apiVersionWithGroup(): string

+

Inherited from KubeApi.apiVersionWithGroup

+

Defined in src/renderer/api/kube-api.ts:153

+

Returns: string

+

Methods#

+

Protected checkPreferredVersion#

+

▸ checkPreferredVersion(): Promise‹void›

+

Inherited from KubeApi.checkPreferredVersion

+

Defined in src/renderer/api/kube-api.ts:215

+

Returns: Promise‹void›

+
+

create#

+

▸ create(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod | null›

+

Inherited from KubeApi.create

+

Defined in src/renderer/api/kube-api.ts:353

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹Pod›

+

Returns: Promise‹Pod | null›

+
+

delete#

+

▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

+

Inherited from KubeApi.delete

+

Defined in src/renderer/api/kube-api.ts:390

+

Parameters:

+

▪ __namedParameters: object

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

Returns: Promise‹KubeJsonApiData›

+
+

get#

+

▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod | null›

+

Inherited from KubeApi.get

+

Defined in src/renderer/api/kube-api.ts:339

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹Pod | null›

+
+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
queryIKubeApiQueryParams{}
+

Returns: string

+
+

list#

+

▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod[] | null›

+

Inherited from KubeApi.list

+

Defined in src/renderer/api/kube-api.ts:321

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
reqInitRequestInit-
+

▪Optional query: IKubeApiQueryParams

+

Returns: Promise‹Pod[] | null›

+
+

Protected modifyWatchEvent#

+

▸ modifyWatchEvent(event: IKubeWatchEvent): void

+

Inherited from KubeApi.modifyWatchEvent

+

Defined in src/renderer/api/kube-api.ts:462

+

Parameters:

+ + + + + + + + + + + + + +
NameType
eventIKubeWatchEvent
+

Returns: void

+
+

Protected normalizeQuery#

+

▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

+

Inherited from KubeApi.normalizeQuery

+

Defined in src/renderer/api/kube-api.ts:268

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
queryPartial‹IKubeApiQueryParams›{}
+

Returns: object

+
+

Protected parseResponse#

+

▸ parseResponse(data: unknown, namespace?: string): Pod | Pod[] | null

+

Inherited from KubeApi.parseResponse

+

Defined in src/renderer/api/kube-api.ts:280

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
dataunknown
namespace?string
+

Returns: Pod | Pod[] | null

+
+

refreshResourceVersion#

+

▸ refreshResourceVersion(params?: KubeApiListOptions): Promise‹T[]›

+

Inherited from KubeApi.refreshResourceVersion

+

Defined in src/renderer/api/kube-api.ts:252

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?KubeApiListOptions
+

Returns: Promise‹T[]›

+
+

setResourceVersion#

+

▸ setResourceVersion(namespace: string, newVersion: string): void

+

Inherited from KubeApi.setResourceVersion

+

Defined in src/renderer/api/kube-api.ts:244

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namespacestring""
newVersionstring-
+

Returns: void

+
+

update#

+

▸ update(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod | null›

+

Inherited from KubeApi.update

+

Defined in src/renderer/api/kube-api.ts:376

+

Parameters:

+

▪Default value __namedParameters: object= {}

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
namestring""
namespacestring"default"
+

▪Optional data: Partial‹Pod›

+

Returns: Promise‹Pod | null›

+
+

watch#

+

▸ watch(opts: KubeApiWatchOptions): function

+

Inherited from KubeApi.watch

+

Defined in src/renderer/api/kube-api.ts:405

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
optsKubeApiWatchOptions{ namespace: "" }
+

Returns: function

+

▸ (): void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html new file mode 100644 index 0000000000..7955affa0b --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html @@ -0,0 +1,2744 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: PodsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: PodsStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Pod›

+

↳ PodsStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new PodsStore(): PodsStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: Pod[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Pod[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemPod
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Pod[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Pod): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemPod
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Pod[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsPod[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Pod): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemPod
dataPartial‹Pod›
+

Returns: Promise‹Pod›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Pod, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Pod

+

▪ request: function

+

▸ (): Promise‹Pod›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html new file mode 100644 index 0000000000..2b0c087bdb --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html @@ -0,0 +1,2069 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: ReplicaSet

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹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:190

+

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

+

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

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

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

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html new file mode 100644 index 0000000000..532f1162c5 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html @@ -0,0 +1,2623 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ReplicaSetStore#

+

Hierarchy#

+

↳ KubeObjectStore‹ReplicaSet›

+

↳ ReplicaSetStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new ReplicaSetStore(): ReplicaSetStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: ReplicaSet[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): ReplicaSet[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemReplicaSet
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: ReplicaSet[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: ReplicaSet): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemReplicaSet
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: ReplicaSet[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsReplicaSet[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: ReplicaSet): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemReplicaSet
dataPartial‹ReplicaSet›
+

Returns: Promise‹ReplicaSet›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: ReplicaSet, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: ReplicaSet

+

▪ request: function

+

▸ (): Promise‹ReplicaSet›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html new file mode 100644 index 0000000000..35bbfbd085 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html @@ -0,0 +1,1913 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

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

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html new file mode 100644 index 0000000000..294859f51f --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuotasStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ResourceQuotasStore#

+

Hierarchy#

+

↳ KubeObjectStore‹ResourceQuota›

+

↳ ResourceQuotasStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new ResourceQuotasStore(): ResourceQuotasStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: ResourceQuotasStore

+

Properties#

+

api#

+

• api: KubeApi‹ResourceQuota‹›› = resourceQuotaApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

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

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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

+
+

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

+

Returns: ResourceQuota[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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

+

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

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): ResourceQuota[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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

+

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

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemResourceQuota
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: ResourceQuota[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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

+

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:258

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: ResourceQuota): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:44

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemResourceQuota
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: ResourceQuota[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsResourceQuota[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: ResourceQuota): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemResourceQuota
dataPartial‹ResourceQuota›
+

Returns: Promise‹ResourceQuota›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: ResourceQuota, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: ResourceQuota

+

▪ request: function

+

▸ (): Promise‹ResourceQuota›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.role/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.role/index.html new file mode 100644 index 0000000000..ba093e9b84 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.role/index.html @@ -0,0 +1,1893 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Role

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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:163

+
+

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:165

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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:211

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

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:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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:74

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html new file mode 100644 index 0000000000..03f3bbbbb6 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html @@ -0,0 +1,1930 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: RoleBinding

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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:163

+
+

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:165

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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:211

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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:74

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html new file mode 100644 index 0000000000..7452f4a636 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html @@ -0,0 +1,2533 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: RoleBindingsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: RoleBindingsStore#

+

Hierarchy#

+

↳ KubeObjectStore‹RoleBinding›

+

↳ RoleBindingsStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new RoleBindingsStore(): RoleBindingsStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: RoleBindingsStore

+

Properties#

+

api#

+

• api: KubeApi‹ClusterRoleBinding‹›› = clusterRoleBindingApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

• items: IObservableArray‹T› = observable.array([], { deep: false })

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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:20

+
+

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:22

+

Returns: RoleBinding[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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:234

+

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:132

+

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:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): RoleBinding[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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(): KubeApi‹RoleBinding‹››[]

+

Overrides KubeObjectStore.getSubscribeApis

+

Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

+

Returns: KubeApi‹RoleBinding‹››[]

+
+

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:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemRoleBinding
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: RoleBinding[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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:209

+

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:137

+

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:224

+

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:180

+

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:169

+

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:252

+

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:120

+

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:258

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: RoleBinding): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemRoleBinding
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: RoleBinding[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsRoleBinding[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: RoleBinding): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemRoleBinding
dataPartial‹RoleBinding›
+

Returns: Promise‹RoleBinding›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: RoleBinding, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

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.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html new file mode 100644 index 0000000000..8eba59cf24 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html @@ -0,0 +1,2496 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: RolesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: RolesStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Role›

+

↳ RolesStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new RolesStore(): RolesStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: RolesStore

+

Properties#

+

api#

+

• api: KubeApi‹ClusterRole‹›› = clusterRoleApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+user-management-roles/roles.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

• items: IObservableArray‹T› = observable.array([], { deep: false })

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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:20

+
+

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:22

+

Returns: Role[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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:234

+

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:132

+

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:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Role[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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(): KubeApi‹Role‹››[]

+

Overrides KubeObjectStore.getSubscribeApis

+

Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

+

Returns: KubeApi‹Role‹››[]

+
+

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:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemRole
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Role[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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:209

+

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:137

+

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:224

+

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:180

+

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:169

+

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:252

+

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:120

+

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:258

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Role): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemRole
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Role[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsRole[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Role): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemRole
dataPartial‹Role›
+

Returns: Promise‹Role›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Role, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Role

+

▪ request: function

+

▸ (): Promise‹Role›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html new file mode 100644 index 0000000000..41603a725c --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html @@ -0,0 +1,1926 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:160

+
+

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:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

Optional status#

+

• status? : any

+

Inherited from KubeObject.status

+

Defined in src/renderer/api/kube-object.ts:163

+
+

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:165

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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:211

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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:74

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html new file mode 100644 index 0000000000..64557f2973 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: SecretsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: SecretsStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Secret›

+

↳ SecretsStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new SecretsStore(): SecretsStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: SecretsStore

+

Properties#

+

api#

+

• api: KubeApi‹Secret‹›› = secretsApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+config-secrets/secrets.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

• items: IObservableArray‹T› = observable.array([], { deep: false })

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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:20

+
+

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:22

+

Returns: Secret[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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:234

+

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:230

+

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:132

+

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:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Secret[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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:271

+

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:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemSecret
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Secret[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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:209

+

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:137

+

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:224

+

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:204

+

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:180

+

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:169

+

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:252

+

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:120

+

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:258

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Secret): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:44

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemSecret
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Secret[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsSecret[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Secret): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemSecret
dataPartial‹Secret›
+

Returns: Promise‹Secret›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Secret, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Secret

+

▪ request: function

+

▸ (): Promise‹Secret›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.service/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.service/index.html new file mode 100644 index 0000000000..c9bc1d14c3 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.service/index.html @@ -0,0 +1,2022 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: Service

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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:165

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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:211

+

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:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

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:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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"

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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:74

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html new file mode 100644 index 0000000000..d76b5a32fc --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html @@ -0,0 +1,1917 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: ServiceAccount

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

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:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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:163

+
+

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:165

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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:211

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

Returns: object[]

+
+

getResourceVersion#

+

▸ getResourceVersion(): string

+

Inherited from KubeObject.getResourceVersion

+

Defined in src/renderer/api/kube-object.ts:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getSecrets#

+

▸ getSecrets(): object[]

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

+

Returns: object[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

toPlainObject#

+

▸ toPlainObject(): object

+

Inherited from KubeObject.toPlainObject

+

Defined in src/renderer/api/kube-object.ts:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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:74

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html new file mode 100644 index 0000000000..13ee9c8b7c --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html @@ -0,0 +1,2514 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccountsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ServiceAccountsStore#

+

Hierarchy#

+

↳ KubeObjectStore‹ServiceAccount›

+

↳ ServiceAccountsStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new ServiceAccountsStore(): ServiceAccountsStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: ServiceAccountsStore

+

Properties#

+

api#

+

• api: KubeApi‹ServiceAccount‹›› = serviceAccountsApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

• items: IObservableArray‹T› = observable.array([], { deep: false })

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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:20

+
+

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:22

+

Returns: ServiceAccount[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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:234

+

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:132

+

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:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): ServiceAccount[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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:271

+

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:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemServiceAccount
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: ServiceAccount[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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:209

+

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:137

+

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:224

+

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:204

+

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:180

+

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:169

+

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:252

+

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:120

+

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:258

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: ServiceAccount): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:44

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemServiceAccount
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: ServiceAccount[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsServiceAccount[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: ServiceAccount): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemServiceAccount
dataPartial‹ServiceAccount›
+

Returns: Promise‹ServiceAccount›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: ServiceAccount, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: ServiceAccount

+

▪ request: function

+

▸ (): Promise‹ServiceAccount›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html new file mode 100644 index 0000000000..a9a955542e --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html @@ -0,0 +1,2516 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: ServiceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: ServiceStore#

+

Hierarchy#

+

↳ KubeObjectStore‹Service›

+

↳ ServiceStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new ServiceStore(): ServiceStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: ServiceStore

+

Properties#

+

api#

+

• api: KubeApi‹Service‹›› = serviceApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+network-services/services.store.ts:8

+
+

bufferSize#

+

• bufferSize: number = 50000

+

Inherited from KubeObjectStore.bufferSize

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

• items: IObservableArray‹T› = observable.array([], { deep: false })

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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:20

+
+

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:22

+

Returns: Service[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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:234

+

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:230

+

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:132

+

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:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): Service[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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:271

+

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:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemService
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: Service[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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:209

+

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:137

+

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:224

+

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:204

+

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:180

+

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:169

+

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:252

+

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:120

+

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:258

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: Service): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:44

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemService
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: Service[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsService[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: Service): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemService
dataPartial‹Service›
+

Returns: Promise‹Service›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: Service, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: Service

+

▪ request: function

+

▸ (): Promise‹Service›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html new file mode 100644 index 0000000000..889fffa0f2 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html @@ -0,0 +1,2063 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: StatefulSet

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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:165

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹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:190

+

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:211

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

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:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

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:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

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[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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:74

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html new file mode 100644 index 0000000000..e9ce4b6301 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html @@ -0,0 +1,2595 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: StatefulSetStore#

+

Hierarchy#

+

↳ KubeObjectStore‹StatefulSet›

+

↳ StatefulSetStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new StatefulSetStore(): StatefulSetStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

• items: IObservableArray‹T› = observable.array([], { deep: false })

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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:20

+
+

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:22

+

Returns: StatefulSet[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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:234

+

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:230

+

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:132

+

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:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): StatefulSet[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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:271

+

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:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemStatefulSet
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: StatefulSet[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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:209

+

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:137

+

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:224

+

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:204

+

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:180

+

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:169

+

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:252

+

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:120

+

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:258

+

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:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: StatefulSet): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:44

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemStatefulSet
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: StatefulSet[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsStatefulSet[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: StatefulSet): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemStatefulSet
dataPartial‹StatefulSet›
+

Returns: Promise‹StatefulSet›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: StatefulSet, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: StatefulSet

+

▪ request: function

+

▸ (): Promise‹StatefulSet›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html new file mode 100644 index 0000000000..9693bf2064 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html @@ -0,0 +1,1970 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:154

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataKubeJsonApiData
+

Returns: StorageClass

+

Properties#

+

apiVersion#

+

• apiVersion: string

+

Inherited from KubeObject.apiVersion

+

Defined in src/renderer/api/kube-object.ts:160

+
+

kind#

+

• kind: string

+

Inherited from KubeObject.kind

+

Defined in src/renderer/api/kube-object.ts:161

+
+

metadata#

+

• metadata: IKubeObjectMetadata

+

Inherited from KubeObject.metadata

+

Defined in src/renderer/api/kube-object.ts:162

+
+

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:163

+
+

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:165

+

Returns: string

+

Methods#

+

delete#

+

▸ delete(params?: JsonApiParams): Promise‹KubeJsonApiData›

+

Inherited from KubeObject.delete

+

Defined in src/renderer/api/kube-object.ts:254

+

Parameters:

+ + + + + + + + + + + + + +
NameType
params?JsonApiParams
+

Returns: Promise‹KubeJsonApiData›

+
+

getAge#

+

▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

+

Inherited from KubeObject.getAge

+

Defined in src/renderer/api/kube-object.ts:190

+

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:211

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
filterbooleanfalse
+

Returns: string[]

+
+

getFinalizers#

+

▸ getFinalizers(): string[]

+

Inherited from KubeObject.getFinalizers

+

Defined in src/renderer/api/kube-object.ts:203

+

Returns: string[]

+
+

getId#

+

▸ getId(): string

+

Inherited from KubeObject.getId

+

Defined in src/renderer/api/kube-object.ts:169

+

Returns: string

+
+

getLabels#

+

▸ getLabels(): string[]

+

Inherited from KubeObject.getLabels

+

Defined in src/renderer/api/kube-object.ts:207

+

Returns: string[]

+
+

getName#

+

▸ getName(): string

+

Inherited from KubeObject.getName

+

Defined in src/renderer/api/kube-object.ts:177

+

Returns: string

+
+

getNs#

+

▸ getNs(): string

+

Inherited from KubeObject.getNs

+

Defined in src/renderer/api/kube-object.ts:181

+

Returns: string

+
+

getOwnerRefs#

+

▸ getOwnerRefs(): object[]

+

Inherited from KubeObject.getOwnerRefs

+

Defined in src/renderer/api/kube-object.ts:221

+

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:173

+

Returns: string

+
+

getSearchFields#

+

▸ getSearchFields(): string[]

+

Inherited from KubeObject.getSearchFields

+

Defined in src/renderer/api/kube-object.ts:230

+

Returns: string[]

+
+

getTimeDiffFromNow#

+

▸ getTimeDiffFromNow(): number

+

Inherited from KubeObject.getTimeDiffFromNow

+

Defined in src/renderer/api/kube-object.ts:186

+

Returns: number

+
+

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:242

+

Returns: object

+
+

update#

+

▸ update‹T›(data: Partial‹T›): Promise‹T›

+

Inherited from KubeObject.update

+

Defined in src/renderer/api/kube-object.ts:247

+

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:74

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataany
+

Returns: KubeObject‹›

+
+

Static isJsonApiData#

+

▸ isJsonApiData(object: unknown): object is KubeJsonApiData

+

Inherited from KubeObject.isJsonApiData

+

Defined in src/renderer/api/kube-object.ts:82

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiData

+
+

Static isJsonApiDataList#

+

▸ isJsonApiDataList‹T›(object: unknown, verifyItem: function): object is KubeJsonApiDataList‹T›

+

Inherited from KubeObject.isJsonApiDataList

+

Defined in src/renderer/api/kube-object.ts:140

+

Type parameters:

+

▪ T

+

Parameters:

+

▪ object: unknown

+

▪ verifyItem: function

+

▸ (val: unknown): val is T

+

Parameters:

+ + + + + + + + + + + + + +
NameType
valunknown
+

Returns: object is KubeJsonApiDataList‹T›

+
+

Static isKubeJsonApiListMetadata#

+

▸ isKubeJsonApiListMetadata(object: unknown): object is KubeJsonApiListMetadata

+

Inherited from KubeObject.isKubeJsonApiListMetadata

+

Defined in src/renderer/api/kube-object.ts:91

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiListMetadata

+
+

Static isKubeJsonApiMetadata#

+

▸ isKubeJsonApiMetadata(object: unknown): object is KubeJsonApiMetadata

+

Inherited from KubeObject.isKubeJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:99

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is KubeJsonApiMetadata

+
+

Static isNonSystem#

+

▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

+

Inherited from KubeObject.isNonSystem

+

Defined in src/renderer/api/kube-object.ts:78

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemKubeJsonApiData | KubeObject
+

Returns: boolean

+
+

Static isPartialJsonApiData#

+

▸ isPartialJsonApiData(object: unknown): object is Partial‹KubeJsonApiData›

+

Inherited from KubeObject.isPartialJsonApiData

+

Defined in src/renderer/api/kube-object.ts:131

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiData›

+
+

Static isPartialJsonApiMetadata#

+

▸ isPartialJsonApiMetadata(object: unknown): object is Partial‹KubeJsonApiMetadata›

+

Inherited from KubeObject.isPartialJsonApiMetadata

+

Defined in src/renderer/api/kube-object.ts:115

+

Parameters:

+ + + + + + + + + + + + + +
NameType
objectunknown
+

Returns: object is Partial‹KubeJsonApiMetadata›

+
+

Static stringifyLabels#

+

▸ stringifyLabels(labels?: object): string[]

+

Inherited from KubeObject.stringifyLabels

+

Defined in src/renderer/api/kube-object.ts:150

+

Parameters:

+ + + + + + + + + + + + + +
NameType
labels?object
+

Returns: string[]

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html new file mode 100644 index 0000000000..162448847b --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html @@ -0,0 +1,2544 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: StorageClassStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: StorageClassStore#

+

Hierarchy#

+

↳ KubeObjectStore‹StorageClass›

+

↳ StorageClassStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new StorageClassStore(): StorageClassStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts:26

+

Returns: StorageClassStore

+

Properties#

+

api#

+

• api: KubeApi‹StorageClass‹›› = storageClassApi

+

Overrides KubeObjectStore.api

+

Defined in src/renderer/components/+storage-classes/storage-class.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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

• items: IObservableArray‹T› = observable.array([], { deep: false })

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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:20

+
+

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:22

+

Returns: StorageClass[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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:234

+

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:230

+

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:132

+

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:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): StorageClass[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

Returns: StorageClass[]

+
+

getPersistentVolumes#

+

▸ getPersistentVolumes(storageClass: StorageClass): PersistentVolume‹›[]

+

Defined in src/renderer/components/+storage-classes/storage-class.store.ts:11

+

Parameters:

+ + + + + + + + + + + + + +
NameType
storageClassStorageClass
+

Returns: PersistentVolume‹›[]

+
+

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:271

+

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:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemStorageClass
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: StorageClass[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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:209

+

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:137

+

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:224

+

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:204

+

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:180

+

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:169

+

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:252

+

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:120

+

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:258

+

Returns: Promise‹void[]›

+
+

reset#

+

▸ reset(): void

+

Inherited from KubeObjectStore.reset

+

Defined in src/renderer/item.store.ts:172

+

Returns: void

+
+

Protected resetOnError#

+

▸ resetOnError(error: any): void

+

Inherited from KubeObjectStore.resetOnError

+

Defined in src/renderer/kube-object.store.ts:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: StorageClass): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:44

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemStorageClass
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: StorageClass[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsStorageClass[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: StorageClass): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemStorageClass
dataPartial‹StorageClass›
+

Returns: Promise‹StorageClass›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: StorageClass, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: StorageClass

+

▪ request: function

+

▸ (): Promise‹StorageClass›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html new file mode 100644 index 0000000000..bcaae98c6d --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html @@ -0,0 +1,2556 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Class: VolumeClaimStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Class: VolumeClaimStore#

+

Hierarchy#

+

↳ KubeObjectStore‹PersistentVolumeClaim›

+

↳ VolumeClaimStore

+

Index#

+

Constructors#

+ +

Properties#

+ +

Accessors#

+ +

Methods#

+ +

Constructors#

+

constructor#

+

+ new VolumeClaimStore(): VolumeClaimStore

+

Inherited from KubeObjectStore.constructor

+

Defined in src/renderer/kube-object.store.ts: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:263

+
+

failedLoading#

+

• failedLoading: boolean = false

+

Inherited from KubeObjectStore.failedLoading

+

Defined in src/renderer/item.store.ts:16

+
+

isLoaded#

+

• isLoaded: boolean = false

+

Inherited from KubeObjectStore.isLoaded

+

Defined in src/renderer/item.store.ts:18

+
+

isLoading#

+

• isLoading: boolean = false

+

Inherited from KubeObjectStore.isLoading

+

Defined in src/renderer/item.store.ts:17

+
+

items#

+

• items: IObservableArray‹T› = observable.array([], { deep: false })

+

Inherited from KubeObjectStore.items

+

Defined in src/renderer/item.store.ts:19

+
+

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:20

+
+

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:22

+

Returns: PersistentVolumeClaim[]

+

Methods#

+

[Symbol.iterator]#

+

▸ [Symbol.iterator](): Generator‹T, void, undefined›

+

Inherited from KubeObjectStore.[Symbol.iterator]

+

Defined in src/renderer/item.store.ts:187

+

Returns: Generator‹T, void, undefined›

+
+

Protected bindWatchEventsUpdater#

+

▸ bindWatchEventsUpdater(delay: number): void

+

Inherited from KubeObjectStore.bindWatchEventsUpdater

+

Defined in src/renderer/kube-object.store.ts:265

+

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:234

+

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:230

+

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:132

+

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:39

+

Parameters:

+ + + + + + + + + + + + + +
NameType
idstring
+

Returns: number

+
+

getItems#

+

▸ getItems(): PersistentVolumeClaim[]

+

Inherited from KubeObjectStore.getItems

+

Defined in src/renderer/item.store.ts:26

+

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:271

+

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:126

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
+

Returns: boolean

+
+

isSelectedAll#

+

▸ isSelectedAll(visibleItems: PersistentVolumeClaim[]): boolean

+

Inherited from KubeObjectStore.isSelectedAll

+

Defined in src/renderer/item.store.ts:160

+

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:209

+

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:137

+

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:224

+

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:204

+

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:180

+

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:169

+

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:252

+

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:120

+

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:258

+

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:200

+

Parameters:

+ + + + + + + + + + + + + +
NameType
errorany
+

Returns: void

+
+

resetSelection#

+

▸ resetSelection(): void

+

Inherited from KubeObjectStore.resetSelection

+

Defined in src/renderer/item.store.ts:167

+

Returns: void

+
+

select#

+

▸ select(item: PersistentVolumeClaim): void

+

Inherited from KubeObjectStore.select

+

Defined in src/renderer/item.store.ts:131

+

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:44

+

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:275

+

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:141

+

Parameters:

+ + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
+

Returns: void

+
+

toggleSelectionAll#

+

▸ toggleSelectionAll(visibleItems: PersistentVolumeClaim[]): void

+

Inherited from KubeObjectStore.toggleSelectionAll

+

Defined in src/renderer/item.store.ts:150

+

Parameters:

+ + + + + + + + + + + + + + + +
NameTypeDefault
visibleItemsPersistentVolumeClaim[]this.items
+

Returns: void

+
+

unselect#

+

▸ unselect(item: PersistentVolumeClaim): void

+

Inherited from KubeObjectStore.unselect

+

Defined in src/renderer/item.store.ts:136

+

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:243

+

Parameters:

+ + + + + + + + + + + + + + + + + +
NameType
itemPersistentVolumeClaim
dataPartial‹PersistentVolumeClaim›
+

Returns: Promise‹PersistentVolumeClaim›

+
+

Protected updateFromEventsBuffer#

+

▸ updateFromEventsBuffer(): void

+

Inherited from KubeObjectStore.updateFromEventsBuffer

+

Defined in src/renderer/kube-object.store.ts:353

+

Returns: void

+
+

Protected updateItem#

+

▸ updateItem(item: PersistentVolumeClaim, request: function): Promise‹T›

+

Inherited from KubeObjectStore.updateItem

+

Defined in src/renderer/item.store.ts:110

+

Parameters:

+

▪ item: PersistentVolumeClaim

+

▪ request: function

+

▸ (): Promise‹PersistentVolumeClaim›

+

Returns: Promise‹T›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html b/v4.2.5/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html new file mode 100644 index 0000000000..3029b0b4c1 --- /dev/null +++ b/v4.2.5/extensions/api/classes/_renderer_api_navigation_.pageparam/index.html @@ -0,0 +1,1535 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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

+
+

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.2.5/extensions/api/classes/lensmainextension/index.html b/v4.2.5/extensions/api/classes/lensmainextension/index.html new file mode 100644 index 0000000000..2a91f4130b --- /dev/null +++ b/v4.2.5/extensions/api/classes/lensmainextension/index.html @@ -0,0 +1,1503 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:27

+

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:20

+
+

isBundled#

+

• isBundled: boolean

+

Inherited from LensMainExtension.isBundled

+

Defined in src/extensions/lens-extension.ts:23

+
+

manifest#

+

• manifest: LensExtensionManifest

+

Inherited from LensMainExtension.manifest

+

Defined in src/extensions/lens-extension.ts:21

+
+

manifestPath#

+

• manifestPath: string

+

Inherited from LensMainExtension.manifestPath

+

Defined in src/extensions/lens-extension.ts:22

+
+

protocolHandlers#

+

• protocolHandlers: ProtocolHandlerRegistration[] = []

+

Inherited from LensMainExtension.protocolHandlers

+

Defined in src/extensions/lens-extension.ts:25

+

Accessors#

+

description#

+

• get description(): string

+

Inherited from LensMainExtension.description

+

Defined in src/extensions/lens-extension.ts:55

+

Returns: string

+
+

name#

+

• get name(): string

+

Inherited from LensMainExtension.name

+

Defined in src/extensions/lens-extension.ts:36

+

Returns: string

+
+

version#

+

• get version(): string

+

Inherited from LensMainExtension.version

+

Defined in src/extensions/lens-extension.ts:40

+

Returns: string

+

Methods#

+

disable#

+

▸ disable(): Promise‹void›

+

Inherited from LensMainExtension.disable

+

Defined in src/extensions/lens-extension.ts:68

+

Returns: Promise‹void›

+
+

enable#

+

▸ enable(): Promise‹void›

+

Inherited from LensMainExtension.enable

+

Defined in src/extensions/lens-extension.ts:60

+

Returns: Promise‹void›

+
+

getExtensionFileFolder#

+

▸ getExtensionFileFolder(): Promise‹string›

+

Inherited from LensMainExtension.getExtensionFileFolder

+

Defined in src/extensions/lens-extension.ts:51

+

getExtensionFileFolder returns the path to an already created folder. This +folder is for the sole use of this extension.

+

Note: there is no security done on this folder, only obfiscation of the +folder name.

+

Returns: Promise‹string›

+
+ +

▸ navigate‹P›(pageId?: string, params?: P, frameId?: number): Promise‹void›

+

Defined in src/extensions/lens-main-extension.ts:9

+

Type parameters:

+

▪ P: object

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + +
NameType
pageId?string
params?P
frameId?number
+

Returns: Promise‹void›

+
+

Protected onActivate#

+

▸ onActivate(): void

+

Inherited from LensMainExtension.onActivate

+

Defined in src/extensions/lens-extension.ts:107

+

Returns: void

+
+

Protected onDeactivate#

+

▸ onDeactivate(): void

+

Inherited from LensMainExtension.onDeactivate

+

Defined in src/extensions/lens-extension.ts:111

+

Returns: void

+
+

toggle#

+

▸ toggle(enable?: boolean): void

+

Inherited from LensMainExtension.toggle

+

Defined in src/extensions/lens-extension.ts:75

+

Parameters:

+ + + + + + + + + + + + + +
NameType
enable?boolean
+

Returns: void

+
+

whenEnabled#

+

▸ whenEnabled(handlers: function): Promise‹(Anonymous function)›

+

Inherited from LensMainExtension.whenEnabled

+

Defined in src/extensions/lens-extension.ts:83

+

Parameters:

+

▪ handlers: function

+

▸ (): Promise‹Function[]›

+

Returns: Promise‹(Anonymous function)›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/classes/lensrendererextension/index.html b/v4.2.5/extensions/api/classes/lensrendererextension/index.html new file mode 100644 index 0000000000..965e7680c0 --- /dev/null +++ b/v4.2.5/extensions/api/classes/lensrendererextension/index.html @@ -0,0 +1,1648 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:27

+

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:20

+
+

isBundled#

+

• isBundled: boolean

+

Inherited from LensMainExtension.isBundled

+

Defined in src/extensions/lens-extension.ts:23

+
+

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:21

+
+

manifestPath#

+

• manifestPath: string

+

Inherited from LensMainExtension.manifestPath

+

Defined in src/extensions/lens-extension.ts:22

+
+

protocolHandlers#

+

• protocolHandlers: ProtocolHandlerRegistration[] = []

+

Inherited from LensMainExtension.protocolHandlers

+

Defined in src/extensions/lens-extension.ts:25

+
+

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:55

+

Returns: string

+
+

name#

+

• get name(): string

+

Inherited from LensMainExtension.name

+

Defined in src/extensions/lens-extension.ts:36

+

Returns: string

+
+

version#

+

• get version(): string

+

Inherited from LensMainExtension.version

+

Defined in src/extensions/lens-extension.ts:40

+

Returns: string

+

Methods#

+

disable#

+

▸ disable(): Promise‹void›

+

Inherited from LensMainExtension.disable

+

Defined in src/extensions/lens-extension.ts:68

+

Returns: Promise‹void›

+
+

enable#

+

▸ enable(): Promise‹void›

+

Inherited from LensMainExtension.enable

+

Defined in src/extensions/lens-extension.ts:60

+

Returns: Promise‹void›

+
+

getExtensionFileFolder#

+

▸ getExtensionFileFolder(): Promise‹string›

+

Inherited from LensMainExtension.getExtensionFileFolder

+

Defined in src/extensions/lens-extension.ts:51

+

getExtensionFileFolder returns the path to an already created folder. This +folder is for the sole use of this extension.

+

Note: there is no security done on this folder, only obfiscation of the +folder name.

+

Returns: Promise‹string›

+
+

isEnabledForCluster#

+

▸ isEnabledForCluster(cluster: Cluster): Promise‹Boolean›

+

Defined in src/extensions/lens-renderer-extension.ts:34

+

Defines if extension is enabled for a given cluster. Defaults to true.

+

Parameters:

+ + + + + + + + + + + + + +
NameType
clusterCluster
+

Returns: Promise‹Boolean›

+
+ +

▸ navigate‹P›(pageId?: string, params?: P): Promise‹void›

+

Defined in src/extensions/lens-renderer-extension.ts: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:107

+

Returns: void

+
+

Protected onDeactivate#

+

▸ onDeactivate(): void

+

Inherited from LensMainExtension.onDeactivate

+

Defined in src/extensions/lens-extension.ts:111

+

Returns: void

+
+

toggle#

+

▸ toggle(enable?: boolean): void

+

Inherited from LensMainExtension.toggle

+

Defined in src/extensions/lens-extension.ts:75

+

Parameters:

+ + + + + + + + + + + + + +
NameType
enable?boolean
+

Returns: void

+
+

whenEnabled#

+

▸ whenEnabled(handlers: function): Promise‹(Anonymous function)›

+

Inherited from LensMainExtension.whenEnabled

+

Defined in src/extensions/lens-extension.ts:83

+

Parameters:

+

▪ handlers: function

+

▸ (): Promise‹Function[]›

+

Returns: Promise‹(Anonymous function)›

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html b/v4.2.5/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html new file mode 100644 index 0000000000..2706feacbb --- /dev/null +++ b/v4.2.5/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -0,0 +1,1139 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Enumeration: NotificationStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html b/v4.2.5/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html new file mode 100644 index 0000000000..0780fdcb43 --- /dev/null +++ b/v4.2.5/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -0,0 +1,1199 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html b/v4.2.5/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html new file mode 100644 index 0000000000..390bcb9b58 --- /dev/null +++ b/v4.2.5/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html @@ -0,0 +1,1139 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Enumeration: KubeObjectStatusLevel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/globals/index.html b/v4.2.5/extensions/api/globals/index.html new file mode 100644 index 0000000000..bf50ca5448 --- /dev/null +++ b/v4.2.5/extensions/api/globals/index.html @@ -0,0 +1,1112 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + @k8slens/extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/index.html b/v4.2.5/extensions/api/index.html new file mode 100644 index 0000000000..a406507ce9 --- /dev/null +++ b/v4.2.5/extensions/api/index.html @@ -0,0 +1,1122 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + API Reference - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html b/v4.2.5/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html new file mode 100644 index 0000000000..ef9b94bc00 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html @@ -0,0 +1,1166 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/v4.2.5/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html new file mode 100644 index 0000000000..cd4018a466 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -0,0 +1,1242 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterModel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ClusterModel#

+

Hierarchy#

+
    +
  • ClusterModel
    • +
+

Implemented by#

+ +

Index#

+

Properties#

+ +

Properties#

+

Optional accessibleNamespaces#

+

• accessibleNamespaces? : string[]

+

Defined in src/common/cluster-store.ts:66

+

List of accessible namespaces

+
+

Optional contextName#

+

• contextName? : string

+

Defined in src/common/cluster-store.ts:52

+

User context in kubeconfig

+
+

id#

+

• id: ClusterId

+

Defined in src/common/cluster-store.ts:43

+

Unique id for a cluster

+
+

Optional kubeConfig#

+

• kubeConfig? : string

+

Defined in src/common/cluster-store.ts:69

+

deprecated

+
+

kubeConfigPath#

+

• kubeConfigPath: string

+

Defined in src/common/cluster-store.ts:46

+

Path to cluster kubeconfig

+
+

Optional metadata#

+

• metadata? : ClusterMetadata

+

Defined in src/common/cluster-store.ts:58

+

Metadata

+
+

Optional ownerRef#

+

• ownerRef? : string

+

Defined in src/common/cluster-store.ts:63

+

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:55

+

Preferences

+
+

Optional workspace#

+

• workspace? : WorkspaceId

+

Defined in src/common/cluster-store.ts:49

+

Workspace id

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html b/v4.2.5/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html new file mode 100644 index 0000000000..c283686868 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -0,0 +1,1185 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: WorkspaceModel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: WorkspaceModel#

+

Hierarchy#

+
    +
  • WorkspaceModel
    • +
+

Implemented by#

+ +

Index#

+

Properties#

+ +

Properties#

+

Optional activeClusterId#

+

• activeClusterId? : ClusterId

+

Defined in src/common/workspace-store.ts:27

+
+

Optional description#

+

• description? : string

+

Defined in src/common/workspace-store.ts:25

+
+

id#

+

• id: WorkspaceId

+

Defined in src/common/workspace-store.ts:23

+
+

name#

+

• name: string

+

Defined in src/common/workspace-store.ts:24

+
+

Optional ownerRef#

+

• ownerRef? : string

+

Defined in src/common/workspace-store.ts:26

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html new file mode 100644 index 0000000000..4d4acb0d01 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -0,0 +1,1138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html new file mode 100644 index 0000000000..1238da982a --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -0,0 +1,1150 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html new file mode 100644 index 0000000000..1f99359a8c --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -0,0 +1,1126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html new file mode 100644 index 0000000000..f972126314 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -0,0 +1,1150 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html new file mode 100644 index 0000000000..53073aad09 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.clusterpagemenuregistration/index.html @@ -0,0 +1,1178 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html new file mode 100644 index 0000000000..708d61e0b6 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -0,0 +1,1126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html new file mode 100644 index 0000000000..10de5faff6 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -0,0 +1,1162 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html new file mode 100644 index 0000000000..8d58a3e80d --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -0,0 +1,1126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html new file mode 100644 index 0000000000..928e5952b4 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -0,0 +1,1150 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html new file mode 100644 index 0000000000..831659d979 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -0,0 +1,1167 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html new file mode 100644 index 0000000000..68698ba69b --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagecomponentprops/index.html @@ -0,0 +1,1136 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponentProps ‹**P**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html new file mode 100644 index 0000000000..01a4babdad --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -0,0 +1,1126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html new file mode 100644 index 0000000000..2dc6edfee2 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -0,0 +1,1126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageMenuComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html new file mode 100644 index 0000000000..1aab6bd457 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -0,0 +1,1151 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_interfaces_index_.pageparams/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pageparams/index.html new file mode 100644 index 0000000000..6c97aafdd9 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pageparams/index.html @@ -0,0 +1,1097 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html new file mode 100644 index 0000000000..bf64b5147f --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -0,0 +1,1152 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html new file mode 100644 index 0000000000..55aa607f13 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.pagetarget/index.html @@ -0,0 +1,1159 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: PageTarget ‹**P**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html new file mode 100644 index 0000000000..ecb8ea33b9 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.protocolhandlerregistration/index.html @@ -0,0 +1,1140 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ProtocolHandlerRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ProtocolHandlerRegistration#

+

ProtocolHandlerRegistration is the data required for an extension to register +a handler to a specific path or dynamic path.

+

Hierarchy#

+
    +
  • ProtocolHandlerRegistration
    • +
+

Index#

+

Properties#

+ +

Properties#

+

handler#

+

• handler: RouteHandler

+

Defined in src/extensions/registries/protocol-handler-registry.ts:7

+
+

pathSchema#

+

• pathSchema: string

+

Defined in src/extensions/registries/protocol-handler-registry.ts:6

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html new file mode 100644 index 0000000000..82efe9dc38 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.registeredpage/index.html @@ -0,0 +1,1174 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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: PageParams‹PageParam›

+

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.2.5/extensions/api/interfaces/_interfaces_index_.routehandler/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.routehandler/index.html new file mode 100644 index 0000000000..51f56d7018 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.routehandler/index.html @@ -0,0 +1,1107 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: RouteHandler - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: RouteHandler#

+

RouteHandler represents the function signature of the handler function for +lens:// protocol routing.

+

Hierarchy#

+
    +
  • RouteHandler
    • +
+

Callable#

+

▸ (params: RouteParams): void

+

Defined in src/extensions/registries/protocol-handler-registry.ts:42

+

RouteHandler represents the function signature of the handler function for +lens:// protocol routing.

+

Parameters:

+ + + + + + + + + + + + + +
NameType
paramsRouteParams
+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.routeparams/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.routeparams/index.html new file mode 100644 index 0000000000..440e841f42 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.routeparams/index.html @@ -0,0 +1,1160 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: RouteParams - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: RouteParams#

+

The collection of the dynamic parts of a URI which initiated a lens:// +protocol request

+

Hierarchy#

+
    +
  • RouteParams
    • +
+

Index#

+

Properties#

+ +

Properties#

+

pathname#

+

• pathname: Record‹string, string›

+

Defined in src/extensions/registries/protocol-handler-registry.ts:23

+

the matching parts of the path. The dynamic parts of the URI path.

+
+ +

• search: Record‹string, string›

+

Defined in src/extensions/registries/protocol-handler-registry.ts:18

+

the parts of the URI query string

+
+

Optional tail#

+

• tail? : string

+

Defined in src/extensions/registries/protocol-handler-registry.ts:35

+

if the most specific path schema that is matched does not cover the whole +of the URI's path. Then this field will be set to the remaining path +segments.

+

Example:

+

If the path schema /landing/:type is the matched schema for the URI +/landing/soft/easy then this field will be set to "/easy".

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/v4.2.5/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html new file mode 100644 index 0000000000..3c51592adb --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -0,0 +1,1141 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBarRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: StatusBarRegistration#

+

Hierarchy#

+
    +
  • StatusBarRegistrationV2
    • +
+

↳ StatusBarRegistration

+

Index#

+

Properties#

+ +

Properties#

+

Optional components#

+

• components? : StatusBarComponents

+

Inherited from StatusBarRegistration.components

+

Defined in src/extensions/registries/status-bar-registry.ts:11

+
+

Optional item#

+

• item? : React.ReactNode

+

Defined in src/extensions/registries/status-bar-registry.ts:18

+

deprecated use components.Item instead

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html new file mode 100644 index 0000000000..9ca0976c52 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -0,0 +1,4572 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html new file mode 100644 index 0000000000..69703b3386 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -0,0 +1,4823 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html new file mode 100644 index 0000000000..cb9c0fbcfe --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -0,0 +1,1250 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/index.html new file mode 100644 index 0000000000..c606de7b3a --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogbooleanparams/index.html @@ -0,0 +1,1187 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogBooleanParams - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ConfirmDialogBooleanParams#

+

Hierarchy#

+
    +
  • ConfirmDialogBooleanParams
    • +
+

↳ ConfirmDialogParams

+

Index#

+

Properties#

+ +

Properties#

+

Optional cancelButtonProps#

+

• cancelButtonProps? : Partial‹ButtonProps›

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:25

+
+

Optional icon#

+

• icon? : ReactNode

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:23

+
+

Optional labelCancel#

+

• labelCancel? : ReactNode

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21

+
+

Optional labelOk#

+

• labelOk? : ReactNode

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

+
+

message#

+

• message: ReactNode

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:22

+
+

Optional okButtonProps#

+

• okButtonProps? : Partial‹ButtonProps›

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:24

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html new file mode 100644 index 0000000000..8e29f2b653 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -0,0 +1,1221 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogParams - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ConfirmDialogParams#

+

Hierarchy#

+ +

↳ ConfirmDialogParams

+

Index#

+

Properties#

+ +

Properties#

+

Optional cancel#

+

• cancel? : function

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16

+

Type declaration:#

+

▸ (): any | Promise‹any›

+
+

Optional cancelButtonProps#

+

• cancelButtonProps? : Partial‹ButtonProps›

+

Inherited from ConfirmDialogParams.cancelButtonProps

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:25

+
+

Optional icon#

+

• icon? : ReactNode

+

Inherited from ConfirmDialogParams.icon

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:23

+
+

Optional labelCancel#

+

• labelCancel? : ReactNode

+

Inherited from ConfirmDialogParams.labelCancel

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21

+
+

Optional labelOk#

+

• labelOk? : ReactNode

+

Inherited from ConfirmDialogParams.labelOk

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

+
+

message#

+

• message: ReactNode

+

Inherited from ConfirmDialogParams.message

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:22

+
+

Optional ok#

+

• ok? : function

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

+

Type declaration:#

+

▸ (): any | Promise‹any›

+
+

Optional okButtonProps#

+

• okButtonProps? : Partial‹ButtonProps›

+

Inherited from ConfirmDialogParams.okButtonProps

+

Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:24

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html new file mode 100644 index 0000000000..4f1b890ee6 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html @@ -0,0 +1,1078 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: ConfirmDialogProps#

+

Hierarchy#

+
    +
  • object
    • +
+

↳ ConfirmDialogProps

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html new file mode 100644 index 0000000000..20cd6ac01a --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -0,0 +1,1138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: CubeSpinnerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html new file mode 100644 index 0000000000..3714f36279 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -0,0 +1,1230 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html new file mode 100644 index 0000000000..0411db7448 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -0,0 +1,4555 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html new file mode 100644 index 0000000000..afe18f76a8 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -0,0 +1,4540 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html new file mode 100644 index 0000000000..126622e45e --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -0,0 +1,1126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerParamTogglerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html new file mode 100644 index 0000000000..89560fa4f0 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -0,0 +1,1236 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html new file mode 100644 index 0000000000..ca7a93db5b --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -0,0 +1,1138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerTitleProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html new file mode 100644 index 0000000000..6f5f973f26 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -0,0 +1,1147 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: GroupSelectOption ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html new file mode 100644 index 0000000000..f277a5e069 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -0,0 +1,4692 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html new file mode 100644 index 0000000000..4980cf7318 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -0,0 +1,1221 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html new file mode 100644 index 0000000000..73c6859167 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -0,0 +1,1126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeEventDetailsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html new file mode 100644 index 0000000000..d4789d3a5f --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -0,0 +1,1147 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailsProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html new file mode 100644 index 0000000000..32005392ff --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -0,0 +1,1672 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:69

+
+

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:62

+
+

Optional customizeHeader#

+

• customizeHeader? : function

+

Inherited from KubeObjectListLayoutProps.customizeHeader

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:55

+

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:78

+

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:68

+

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:74

+
+

Optional filterItems#

+

• filterItems? : ItemsFilter‹T›[]

+

Inherited from KubeObjectListLayoutProps.filterItems

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:49

+

deprecated

+
+

Optional hasDetailsView#

+

• hasDetailsView? : boolean

+

Inherited from KubeObjectListLayoutProps.hasDetailsView

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:73

+
+

Optional headerClassName#

+

• headerClassName? : IClassName

+

Inherited from KubeObjectListLayoutProps.headerClassName

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53

+
+

Optional hideFilters#

+

• hideFilters? : boolean

+

Inherited from KubeObjectListLayoutProps.hideFilters

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46

+
+

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:61

+
+

Optional isReady#

+

• isReady? : boolean

+

Inherited from KubeObjectListLayoutProps.isReady

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58

+
+

Optional isSearchable#

+

• isSearchable? : boolean

+

Inherited from KubeObjectListLayoutProps.isSearchable

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60

+
+

Optional isSelectable#

+

• isSelectable? : boolean

+

Inherited from KubeObjectListLayoutProps.isSelectable

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59

+
+

Optional items#

+

• items? : T[]

+

Inherited from KubeObjectListLayoutProps.items

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41

+
+

Optional onDetails#

+

• onDetails? : function

+

Inherited from KubeObjectListLayoutProps.onDetails

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:75

+

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:79

+

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:54

+
+

Optional renderItemMenu#

+

• renderItemMenu? : function

+

Inherited from KubeObjectListLayoutProps.renderItemMenu

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:67

+

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:66

+

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:65

+
+

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:52

+
+

Optional sortingCallbacks#

+

• sortingCallbacks? : object

+

Inherited from KubeObjectListLayoutProps.sortingCallbacks

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:63

+

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:64

+
+

Optional virtual#

+

• virtual? : boolean

+

Inherited from KubeObjectListLayoutProps.virtual

+

Defined in src/renderer/components/item-object-list/item-list-layout.tsx:70

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html new file mode 100644 index 0000000000..01a0801a94 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html @@ -0,0 +1,1274 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html new file mode 100644 index 0000000000..7f304acb41 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html @@ -0,0 +1,1138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMetaProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html new file mode 100644 index 0000000000..6fa47b274d --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html @@ -0,0 +1,5940 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html new file mode 100644 index 0000000000..b46cc2238f --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html @@ -0,0 +1,1225 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html new file mode 100644 index 0000000000..57b01a34a9 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html @@ -0,0 +1,5931 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:307

+
+

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:306

+
+

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:309

+
+

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:305

+
+

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:308

+
+

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.2.5/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html new file mode 100644 index 0000000000..76a75479ad --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html @@ -0,0 +1,1162 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html new file mode 100644 index 0000000000..cdb139d0bf --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html @@ -0,0 +1,1307 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.notification/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.notification/index.html new file mode 100644 index 0000000000..ac1500f80e --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.notification/index.html @@ -0,0 +1,1198 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html new file mode 100644 index 0000000000..5ebc3ad764 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html @@ -0,0 +1,3350 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:19

+

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:11

+
+

Optional contentClass#

+

• contentClass? : IClassName

+

Defined in src/renderer/components/layout/page-layout.tsx:14

+
+

Optional contentGaps#

+

• contentGaps? : boolean

+

Defined in src/renderer/components/layout/page-layout.tsx:16

+
+

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:12

+
+

Optional headerClass#

+

• headerClass? : IClassName

+

Defined in src/renderer/components/layout/page-layout.tsx:13

+
+

Optional navigation#

+

• navigation? : NavigationTree[]

+

Defined in src/renderer/components/layout/page-layout.tsx:18

+
+

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:15

+
+

Optional showOnTop#

+

• showOnTop? : boolean

+

Defined in src/renderer/components/layout/page-layout.tsx:17

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html new file mode 100644 index 0000000000..cb0c3a9829 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html @@ -0,0 +1,1213 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html new file mode 100644 index 0000000000..a57510b980 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -0,0 +1,1147 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: SelectOption ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html new file mode 100644 index 0000000000..6b1e39de52 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -0,0 +1,2412 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html new file mode 100644 index 0000000000..e62931ac89 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -0,0 +1,1182 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html new file mode 100644 index 0000000000..9fa1ce3c9a --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -0,0 +1,5919 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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 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.2.5/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html new file mode 100644 index 0000000000..6e075325ea --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -0,0 +1,4536 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html new file mode 100644 index 0000000000..e93aaa75ae --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -0,0 +1,5907 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html new file mode 100644 index 0000000000..aadc4542fe --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -0,0 +1,1162 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html new file mode 100644 index 0000000000..a03c1f1d0a --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -0,0 +1,1186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html new file mode 100644 index 0000000000..686c7fec84 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -0,0 +1,3396 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html new file mode 100644 index 0000000000..dd7dc3ef2f --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -0,0 +1,3273 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html new file mode 100644 index 0000000000..126e1dfff9 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -0,0 +1,3502 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:26

+
+

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:25

+
+

Optional customRowHeights#

+

• customRowHeights? : function

+

Defined in src/renderer/components/table/table.tsx:43

+

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:44

+

Type declaration:#

+

▸ (uid: string): ReactElement‹TableRowProps›

+

Parameters:

+ + + + + + + + + + + + + +
NameType
uidstring
+
+

Optional items#

+

• items? : ItemObject[]

+

Defined in src/renderer/components/table/table.tsx:24

+
+

Optional noItems#

+

• noItems? : React.ReactNode

+

Defined in src/renderer/components/table/table.tsx:38

+
+

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:37

+

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:42

+
+

Optional rowPadding#

+

• rowPadding? : string

+

Defined in src/renderer/components/table/table.tsx:41

+
+

Optional scrollable#

+

• scrollable? : boolean

+

Defined in src/renderer/components/table/table.tsx:28

+
+

Optional selectable#

+

• selectable? : boolean

+

Defined in src/renderer/components/table/table.tsx:27

+
+

Optional selectedItemId#

+

• selectedItemId? : string

+

Defined in src/renderer/components/table/table.tsx:39

+
+

Optional sortByDefault#

+

• sortByDefault? : Partial‹TableSortParams›

+

Defined in src/renderer/components/table/table.tsx:36

+
+

Optional sortSyncWithUrl#

+

• sortSyncWithUrl? : boolean

+

Defined in src/renderer/components/table/table.tsx:35

+
+

Optional sortable#

+

• sortable? : TableSortCallbacks

+

Defined in src/renderer/components/table/table.tsx:34

+

Define sortable callbacks for every column in

+

sortitem argument in the callback is an object, provided in

+
+

Optional storageKey#

+

• storageKey? : string

+

Defined in src/renderer/components/table/table.tsx:29

+
+

Optional tableId#

+

• tableId? : string

+

Defined in src/renderer/components/table/table.tsx:23

+
+

Optional virtual#

+

• virtual? : boolean

+

Defined in src/renderer/components/table/table.tsx:40

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html new file mode 100644 index 0000000000..3ffdd3ebae --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html @@ -0,0 +1,3309 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html new file mode 100644 index 0000000000..7891308c5d --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html @@ -0,0 +1,3318 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html new file mode 100644 index 0000000000..6c2b360452 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html @@ -0,0 +1,1268 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html new file mode 100644 index 0000000000..4dd9b3ba18 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -0,0 +1,1174 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html new file mode 100644 index 0000000000..f78677d29e --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -0,0 +1,1145 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html new file mode 100644 index 0000000000..b0916940d6 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -0,0 +1,1234 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html new file mode 100644 index 0000000000..a912e34576 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -0,0 +1,3309 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html new file mode 100644 index 0000000000..7a4ee8877f --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html @@ -0,0 +1,1276 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html new file mode 100644 index 0000000000..34371127ba --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html @@ -0,0 +1,1511 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html new file mode 100644 index 0000000000..9f4426308d --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html @@ -0,0 +1,1126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: IKubeApiCluster - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Interface: IKubeApiCluster#

+

Hierarchy#

+
    +
  • IKubeApiCluster
    • +
+

Index#

+

Properties#

+ +

Properties#

+

id#

+

• id: string

+

Defined in src/renderer/api/kube-api.ts:71

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html new file mode 100644 index 0000000000..6a0c7df151 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html @@ -0,0 +1,1291 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html new file mode 100644 index 0000000000..4bf6beb793 --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html @@ -0,0 +1,1294 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html new file mode 100644 index 0000000000..a596bac39f --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html @@ -0,0 +1,1138 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: ISecretRef - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html new file mode 100644 index 0000000000..988b5fdedd --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html @@ -0,0 +1,1160 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Interface: IURLParams ‹**P, Q**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html b/v4.2.5/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html new file mode 100644 index 0000000000..c592992ffe --- /dev/null +++ b/v4.2.5/extensions/api/interfaces/_renderer_api_navigation_.pageparaminit/index.html @@ -0,0 +1,1274 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/modules/_core_api_app_/index.html b/v4.2.5/extensions/api/modules/_core_api_app_/index.html new file mode 100644 index 0000000000..00a325150b --- /dev/null +++ b/v4.2.5/extensions/api/modules/_core_api_app_/index.html @@ -0,0 +1,1235 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/modules/_core_api_cluster_feature_/index.html b/v4.2.5/extensions/api/modules/_core_api_cluster_feature_/index.html new file mode 100644 index 0000000000..7b8cb70ce4 --- /dev/null +++ b/v4.2.5/extensions/api/modules/_core_api_cluster_feature_/index.html @@ -0,0 +1,1102 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/cluster-feature" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/modules/_core_api_event_bus_/index.html b/v4.2.5/extensions/api/modules/_core_api_event_bus_/index.html new file mode 100644 index 0000000000..c9abcaf6cd --- /dev/null +++ b/v4.2.5/extensions/api/modules/_core_api_event_bus_/index.html @@ -0,0 +1,1162 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/api/modules/_core_api_stores_/index.html b/v4.2.5/extensions/api/modules/_core_api_stores_/index.html new file mode 100644 index 0000000000..016296fb5b --- /dev/null +++ b/v4.2.5/extensions/api/modules/_core_api_stores_/index.html @@ -0,0 +1,1201 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:39

+
+

WorkspaceId#

+

Ƭ WorkspaceId: string

+

Defined in src/common/workspace-store.ts:13

+

Variables#

+

Const clusterStore#

+

• clusterStore: ClusterStore‹› = ClusterStore.getInstance()

+

Defined in src/extensions/stores/cluster-store.ts:133

+
+

Const workspaceStore#

+

• workspaceStore: WorkspaceStore‹› = WorkspaceStore.getInstance()

+

Defined in src/extensions/stores/workspace-store.ts:127

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/modules/_core_api_utils_/index.html b/v4.2.5/extensions/api/modules/_core_api_utils_/index.html new file mode 100644 index 0000000000..794cfdc7fd --- /dev/null +++ b/v4.2.5/extensions/api/modules/_core_api_utils_/index.html @@ -0,0 +1,1231 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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#

+

▸ prevDefault‹E›(callback: function): (Anonymous function)

+

Defined in src/renderer/utils/prevDefault.ts:15

+

Type parameters:

+

▪ E: SyntheticEvent | Event

+

Parameters:

+

▪ callback: function

+

▸ (evt: E): any

+

Parameters:

+ + + + + + + + + + + + + +
NameType
evtE
+

Returns: (Anonymous function)

+
+

stopPropagation#

+

▸ stopPropagation(evt: Event | SyntheticEvent): void

+

Defined in src/renderer/utils/prevDefault.ts:24

+

Parameters:

+ + + + + + + + + + + + + +
NameType
evtEvent | SyntheticEvent
+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/modules/_interfaces_index_/index.html b/v4.2.5/extensions/api/modules/_interfaces_index_/index.html new file mode 100644 index 0000000000..9ff1691963 --- /dev/null +++ b/v4.2.5/extensions/api/modules/_interfaces_index_/index.html @@ -0,0 +1,1112 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Module: "interfaces/index" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Module: "interfaces/index"#

+

Index#

+

Interfaces#

+ + + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/modules/_renderer_api_components_/index.html b/v4.2.5/extensions/api/modules/_renderer_api_components_/index.html new file mode 100644 index 0000000000..c899071f48 --- /dev/null +++ b/v4.2.5/extensions/api/modules/_renderer_api_components_/index.html @@ -0,0 +1,1834 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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:17

+
+

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:16

+
+

TableSortCallback#

+

Ƭ TableSortCallback: function

+

Defined in src/renderer/components/table/table.tsx:19

+

Type declaration:#

+

▸ (data: D): string | number | (string | number)[]

+

Parameters:

+ + + + + + + + + + + + + +
NameType
dataD
+
+

TableSortCallbacks#

+

Ƭ TableSortCallbacks: object

+

Defined in src/renderer/components/table/table.tsx:20

+

Type declaration:#

+ +
+

TableSortParams#

+

Ƭ TableSortParams: object

+

Defined in src/renderer/components/table/table.tsx:18

+

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:19

+

Used to store object.selfLink to show more info about resource in the details panel.

+
+

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:31

+

Used to highlight last active/selected table row with the resource.

+

example +If we go to "Nodes (page) -> Node (details) -> Pod (details)", +last clicked Node should be "active" while Pod details are shown).

+
+

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:52

+
+

Const sortByUrlParam#

+

• sortByUrlParam: PageParam‹string› = createPageParam({ + name: "sort", + isSystem: true, +})

+

Defined in src/renderer/components/table/table.tsx:47

+
+

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:289

+

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(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
selfLinkstring-
resetSelectedbooleanfalse
mergeGlobalsbooleantrue
+

Returns: string

+
+

hideDetails#

+

▸ hideDetails(): void

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

+

Returns: void

+
+

showDetails#

+

▸ showDetails(selfLink: string, resetSelected: boolean): void

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
selfLinkstring""
resetSelectedbooleantrue
+

Returns: void

+
+

withTooltip#

+

▸ withTooltip‹T›(Target: T): T

+

Defined in src/renderer/components/tooltip/withTooltip.tsx:18

+

Type parameters:

+

▪ T: React.ComponentType‹any›

+

Parameters:

+ + + + + + + + + + + + + +
NameType
TargetT
+

Returns: T

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/modules/_renderer_api_k8s_api_/index.html b/v4.2.5/extensions/api/modules/_renderer_api_k8s_api_/index.html new file mode 100644 index 0000000000..e408639987 --- /dev/null +++ b/v4.2.5/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -0,0 +1,1758 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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: KubeApi‹ClusterRole‹›› = new KubeApi({ + objectConstructor: ClusterRole, +})

+

Defined in src/renderer/api/endpoints/cluster-role.api.ts:12

+
+

Const clusterRoleBindingApi#

+

• clusterRoleBindingApi: KubeApi‹ClusterRoleBinding‹›› = new KubeApi({ + objectConstructor: ClusterRoleBinding, +})

+

Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10

+
+

Const configMapApi#

+

• configMapApi: KubeApi‹ConfigMap‹›› = new KubeApi({ + objectConstructor: ConfigMap, +})

+

Defined in src/renderer/api/endpoints/configmap.api.ts:26

+
+

Const crdApi#

+

• crdApi: KubeApi‹CustomResourceDefinition‹›› = new KubeApi({ + objectConstructor: CustomResourceDefinition, + checkPreferredVersion: true, +})

+

Defined in src/renderer/api/endpoints/crd.api.ts:154

+
+

Const cronJobApi#

+

• cronJobApi: CronJobApi‹› = new CronJobApi({ + objectConstructor: CronJob, +})

+

Defined in src/renderer/api/endpoints/cron-job.api.ts:131

+
+

Const daemonSetApi#

+

• daemonSetApi: KubeApi‹DaemonSet‹›› = new KubeApi({ + objectConstructor: DaemonSet, +})

+

Defined in src/renderer/api/endpoints/daemon-set.api.ts:74

+
+

Const deploymentApi#

+

• deploymentApi: DeploymentApi‹› = new DeploymentApi({ + objectConstructor: Deployment, +})

+

Defined in src/renderer/api/endpoints/deployment.api.ts:192

+
+

Const endpointApi#

+

• endpointApi: KubeApi‹Endpoint‹›› = new KubeApi({ + objectConstructor: Endpoint, +})

+

Defined in src/renderer/api/endpoints/endpoint.api.ts:127

+
+

Const eventApi#

+

• eventApi: KubeApi‹KubeEvent‹›› = new KubeApi({ + objectConstructor: KubeEvent, +})

+

Defined in src/renderer/api/endpoints/events.api.ts:59

+
+

Const hpaApi#

+

• hpaApi: KubeApi‹HorizontalPodAutoscaler‹›› = new KubeApi({ + objectConstructor: HorizontalPodAutoscaler, +})

+

Defined in src/renderer/api/endpoints/hpa.api.ts:143

+
+

Const ingressApi#

+

• ingressApi: IngressApi‹› = new IngressApi({ + objectConstructor: Ingress, + // Add fallback for Kubernetes <1.19 + checkPreferredVersion: true, + fallbackApiBases: ["/apis/extensions/v1beta1/ingresses"], + logStuff: true +} as any)

+

Defined in src/renderer/api/endpoints/ingress.api.ts:177

+
+

Const jobApi#

+

• jobApi: KubeApi‹Job‹›› = new KubeApi({ + objectConstructor: Job, +})

+

Defined in src/renderer/api/endpoints/job.api.ts:110

+
+

Const limitRangeApi#

+

• limitRangeApi: KubeApi‹LimitRange‹›› = new KubeApi({ + objectConstructor: LimitRange, +})

+

Defined in src/renderer/api/endpoints/limit-range.api.ts:55

+
+

Const namespacesApi#

+

• namespacesApi: KubeApi‹Namespace‹›› = new KubeApi({ + objectConstructor: Namespace, +})

+

Defined in src/renderer/api/endpoints/namespaces.api.ts:25

+
+

Const networkPolicyApi#

+

• networkPolicyApi: KubeApi‹NetworkPolicy‹›› = new KubeApi({ + objectConstructor: NetworkPolicy, +})

+

Defined in src/renderer/api/endpoints/network-policy.api.ts:71

+
+

Const nodesApi#

+

• nodesApi: NodesApi‹› = new NodesApi({ + objectConstructor: Node, +})

+

Defined in src/renderer/api/endpoints/nodes.api.ts:169

+
+

Const pdbApi#

+

• pdbApi: KubeApi‹PodDisruptionBudget‹›› = new KubeApi({ + objectConstructor: PodDisruptionBudget, +})

+

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47

+
+

Const persistentVolumeApi#

+

• persistentVolumeApi: KubeApi‹PersistentVolume‹›› = new KubeApi({ + objectConstructor: PersistentVolume, +})

+

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:79

+
+

Const podsApi#

+

• podsApi: PodsApi‹› = new PodsApi({ + objectConstructor: Pod, +})

+

Defined in src/renderer/api/endpoints/pods.api.ts:469

+
+

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: KubeApi‹ResourceQuota‹›› = new KubeApi({ + objectConstructor: ResourceQuota, +})

+

Defined in src/renderer/api/endpoints/resource-quota.api.ts:66

+
+

Const roleApi#

+

• roleApi: KubeApi‹Role‹›› = new KubeApi({ + objectConstructor: Role, +})

+

Defined in src/renderer/api/endpoints/role.api.ts:21

+
+

Const roleBindingApi#

+

• roleBindingApi: KubeApi‹RoleBinding‹›› = new KubeApi({ + objectConstructor: RoleBinding, +})

+

Defined in src/renderer/api/endpoints/role-binding.api.ts:34

+
+

Const secretsApi#

+

• secretsApi: KubeApi‹Secret‹›› = new KubeApi({ + objectConstructor: Secret, +})

+

Defined in src/renderer/api/endpoints/secret.api.ts:48

+
+

Const serviceAccountsApi#

+

• serviceAccountsApi: KubeApi‹ServiceAccount‹›› = new KubeApi({ + objectConstructor: ServiceAccount, +})

+

Defined in src/renderer/api/endpoints/service-accounts.api.ts:27

+
+

Const serviceApi#

+

• serviceApi: KubeApi‹Service‹›› = new KubeApi({ + objectConstructor: Service, +})

+

Defined in src/renderer/api/endpoints/service.api.ts:101

+
+

Const statefulSetApi#

+

• statefulSetApi: StatefulSetApi‹› = new StatefulSetApi({ + objectConstructor: StatefulSet, +})

+

Defined in src/renderer/api/endpoints/stateful-set.api.ts:110

+
+

Const storageClassApi#

+

• storageClassApi: KubeApi‹StorageClass‹›› = new KubeApi({ + objectConstructor: StorageClass, +})

+

Defined in src/renderer/api/endpoints/storage-class.api.ts:37

+

Functions#

+

forCluster#

+

▸ forCluster‹T›(cluster: IKubeApiCluster, kubeClass: IKubeObjectConstructor‹T›): KubeApi‹T›

+

Defined in src/renderer/api/kube-api.ts:74

+

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.2.5/extensions/api/modules/_renderer_api_navigation_/index.html b/v4.2.5/extensions/api/modules/_renderer_api_navigation_/index.html new file mode 100644 index 0000000000..5e8ef142d8 --- /dev/null +++ b/v4.2.5/extensions/api/modules/_renderer_api_navigation_/index.html @@ -0,0 +1,1300 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/navigation" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Module: "renderer-api/navigation"#

+

Index#

+

Classes#

+ +

Interfaces#

+ +

Functions#

+ +

Functions#

+

createPageParam#

+

▸ createPageParam‹V›(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(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
selfLinkstring-
resetSelectedbooleanfalse
mergeGlobalsbooleantrue
+

Returns: string

+
+

hideDetails#

+

▸ hideDetails(): void

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

+

Returns: void

+
+

isActiveRoute#

+

▸ isActiveRoute(route: string | string[] | RouteProps): boolean

+

Defined in src/renderer/navigation/helpers.ts:25

+

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(selfLink: string, resetSelected: boolean): void

+

Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

+

Parameters:

+ + + + + + + + + + + + + + + + + + + + +
NameTypeDefault
selfLinkstring""
resetSelectedbooleantrue
+

Returns: void

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/api/modules/_renderer_api_theming_/index.html b/v4.2.5/extensions/api/modules/_renderer_api_theming_/index.html new file mode 100644 index 0000000000..7d03c69c09 --- /dev/null +++ b/v4.2.5/extensions/api/modules/_renderer_api_theming_/index.html @@ -0,0 +1,1116 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/theming" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/capabilities/color-reference/index.html b/v4.2.5/extensions/capabilities/color-reference/index.html new file mode 100644 index 0000000000..0532fdf2a2 --- /dev/null +++ b/v4.2.5/extensions/capabilities/color-reference/index.html @@ -0,0 +1,1462 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/capabilities/common-capabilities/index.html b/v4.2.5/extensions/capabilities/common-capabilities/index.html new file mode 100644 index 0000000000..d2472d0353 --- /dev/null +++ b/v4.2.5/extensions/capabilities/common-capabilities/index.html @@ -0,0 +1,1582 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/capabilities/images/css-vars-in-devtools.png b/v4.2.5/extensions/capabilities/images/css-vars-in-devtools.png new file mode 100644 index 0000000000..a9df97e6bb Binary files /dev/null and b/v4.2.5/extensions/capabilities/images/css-vars-in-devtools.png differ diff --git a/v4.2.5/extensions/capabilities/images/theme-selector.png b/v4.2.5/extensions/capabilities/images/theme-selector.png new file mode 100644 index 0000000000..5c2eba3165 Binary files /dev/null and b/v4.2.5/extensions/capabilities/images/theme-selector.png differ diff --git a/v4.2.5/extensions/capabilities/index.html b/v4.2.5/extensions/capabilities/index.html new file mode 100644 index 0000000000..0d7ab83f49 --- /dev/null +++ b/v4.2.5/extensions/capabilities/index.html @@ -0,0 +1,1038 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Index - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+ + + + +

Index

+ + + + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/capabilities/styling/index.html b/v4.2.5/extensions/capabilities/styling/index.html new file mode 100644 index 0000000000..6cfbd3139e --- /dev/null +++ b/v4.2.5/extensions/capabilities/styling/index.html @@ -0,0 +1,1393 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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 theme 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.2.5/extensions/get-started/anatomy/index.html b/v4.2.5/extensions/get-started/anatomy/index.html new file mode 100644 index 0000000000..fdd88f9b9c --- /dev/null +++ b/v4.2.5/extensions/get-started/anatomy/index.html @@ -0,0 +1,1291 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/get-started/overview/index.html b/v4.2.5/extensions/get-started/overview/index.html new file mode 100644 index 0000000000..6a899109e6 --- /dev/null +++ b/v4.2.5/extensions/get-started/overview/index.html @@ -0,0 +1,1187 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Extension Development Overview#

+

This is a general overview to how the development of an extension will proceed. +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 compatible 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 responsible 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.2.5/extensions/get-started/wrapping-up/index.html b/v4.2.5/extensions/get-started/wrapping-up/index.html new file mode 100644 index 0000000000..8fcb633ab4 --- /dev/null +++ b/v4.2.5/extensions/get-started/wrapping-up/index.html @@ -0,0 +1,1197 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/get-started/your-first-extension/index.html b/v4.2.5/extensions/get-started/your-first-extension/index.html new file mode 100644 index 0000000000..9fc47bc561 --- /dev/null +++ b/v4.2.5/extensions/get-started/your-first-extension/index.html @@ -0,0 +1,1309 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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. +
  2. In page.tsx, change the message from HelloWorld! to Hello Lens Extensions.
    3. +
  3. Rebuild the extension. If you used npm run dev, the extension will rebuild automatically.
    4. +
  4. Reload the Lens window.
    5. +
  5. Click on the Hello World page.
    6. +
  6. The updated message will appear.
    7. +
+

Next Steps#

+

In the next topic, we'll take a closer look at the source code of our Hello World sample.

+

You can find the source code for this tutorial at: lensapp/lens-extension-samples. +Extension Guides contains additional samples.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/guides/anatomy/index.html b/v4.2.5/extensions/guides/anatomy/index.html new file mode 100644 index 0000000000..9122dc6fbe --- /dev/null +++ b/v4.2.5/extensions/guides/anatomy/index.html @@ -0,0 +1,1074 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Anatomy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Anatomy

+ +
+

WIP#

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/guides/components/index.html b/v4.2.5/extensions/guides/components/index.html new file mode 100644 index 0000000000..c411767e38 --- /dev/null +++ b/v4.2.5/extensions/guides/components/index.html @@ -0,0 +1,1074 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Components - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Components

+ +
+

WIP#

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/guides/generator/index.html b/v4.2.5/extensions/guides/generator/index.html new file mode 100644 index 0000000000..c61627c763 --- /dev/null +++ b/v4.2.5/extensions/guides/generator/index.html @@ -0,0 +1,1241 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/guides/images/certificates-crd-list.png b/v4.2.5/extensions/guides/images/certificates-crd-list.png new file mode 100644 index 0000000000..19c9558f71 Binary files /dev/null and b/v4.2.5/extensions/guides/images/certificates-crd-list.png differ diff --git a/v4.2.5/extensions/guides/images/clusterpagemenus.png b/v4.2.5/extensions/guides/images/clusterpagemenus.png new file mode 100644 index 0000000000..3ed1c79e5b Binary files /dev/null and b/v4.2.5/extensions/guides/images/clusterpagemenus.png differ diff --git a/v4.2.5/extensions/guides/images/globalpagemenus.png b/v4.2.5/extensions/guides/images/globalpagemenus.png new file mode 100644 index 0000000000..e986cc32e9 Binary files /dev/null and b/v4.2.5/extensions/guides/images/globalpagemenus.png differ diff --git a/v4.2.5/extensions/guides/images/hello-lens.png b/v4.2.5/extensions/guides/images/hello-lens.png new file mode 100644 index 0000000000..5e2c0ac0a5 Binary files /dev/null and b/v4.2.5/extensions/guides/images/hello-lens.png differ diff --git a/v4.2.5/extensions/guides/images/hello-world.png b/v4.2.5/extensions/guides/images/hello-world.png new file mode 100644 index 0000000000..1a4a9c73a9 Binary files /dev/null and b/v4.2.5/extensions/guides/images/hello-world.png differ diff --git a/v4.2.5/extensions/guides/images/kubeobjectdetailitem.png b/v4.2.5/extensions/guides/images/kubeobjectdetailitem.png new file mode 100644 index 0000000000..e2d68f0c3b Binary files /dev/null and b/v4.2.5/extensions/guides/images/kubeobjectdetailitem.png differ diff --git a/v4.2.5/extensions/guides/images/kubeobjectdetailitemwithpods.png b/v4.2.5/extensions/guides/images/kubeobjectdetailitemwithpods.png new file mode 100644 index 0000000000..9a91f230f3 Binary files /dev/null and b/v4.2.5/extensions/guides/images/kubeobjectdetailitemwithpods.png differ diff --git a/v4.2.5/extensions/guides/images/kubeobjectmenuitem.png b/v4.2.5/extensions/guides/images/kubeobjectmenuitem.png new file mode 100644 index 0000000000..f9f91675de Binary files /dev/null and b/v4.2.5/extensions/guides/images/kubeobjectmenuitem.png differ diff --git a/v4.2.5/extensions/guides/images/kubeobjectmenuitemdetail.png b/v4.2.5/extensions/guides/images/kubeobjectmenuitemdetail.png new file mode 100644 index 0000000000..ab5f9ac0f0 Binary files /dev/null and b/v4.2.5/extensions/guides/images/kubeobjectmenuitemdetail.png differ diff --git a/v4.2.5/extensions/guides/images/routing-diag.png b/v4.2.5/extensions/guides/images/routing-diag.png new file mode 100644 index 0000000000..9185ce94d8 Binary files /dev/null and b/v4.2.5/extensions/guides/images/routing-diag.png differ diff --git a/v4.2.5/extensions/guides/index.html b/v4.2.5/extensions/guides/index.html new file mode 100644 index 0000000000..7a5319d9b5 --- /dev/null +++ b/v4.2.5/extensions/guides/index.html @@ -0,0 +1,1255 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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
Protocol Handlers
+

Samples#

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SampleAPIs
hello-worldLensMainExtension
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.2.5/extensions/guides/kube-object-list-layout/index.html b/v4.2.5/extensions/guides/kube-object-list-layout/index.html new file mode 100644 index 0000000000..5053bfbc6d --- /dev/null +++ b/v4.2.5/extensions/guides/kube-object-list-layout/index.html @@ -0,0 +1,1353 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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 ClusterPage and ClusterPageMenu objects
    2. +
  2. List Certificate Objects on the Cluster Page
    3. +
  3. Customize Details Panel
    4. +
+

Register clusterPage and clusterPageMenu Objects#

+

First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. +We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class:

+
export default class CrdSampleExtension extends LensRendererExtension {
+}
+
+

To register menu item in the cluster menu we need to register PageMenuRegistration object. +This object will register a menu item with "Certificates" text. +It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id.

+
export function CertificateIcon(props: Component.IconProps) {
+  return <Component.Icon {...props} material="security" tooltip="Certificates"/>
+}
+
+export default class CrdSampleExtension extends LensRendererExtension {
+
+  clusterPageMenus = [
+    {
+      target: { pageId: "certificates" },
+      title: "Certificates",
+      components: {
+        Icon: CertificateIcon,
+      }
+    },
+  ]
+}
+
+

Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates.

+
export default class CrdSampleExtension extends LensRendererExtension {
+  ...
+
+  clusterPages = [{
+    id: "certificates",
+    components: {
+      Page: () => <CertificatePage extension={this} />,
+      MenuIcon: CertificateIcon,
+    }
+  }]
+}
+
+

List Certificate Objects on the Cluster Page#

+

In the previous step we defined CertificatePage component to render certificates. +In this step we will actually implement that. +CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects.

+

Get CRD objects#

+

In order to list CRD objects, we need first fetch those from Kubernetes API. +Lens Extensions API provides easy mechanism to do this. +We just need to define Certificate class derived from K8sApi.KubeObject, CertificatesApiderived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore.

+

Certificate class defines properties found in the CRD object:

+
export class Certificate extends K8sApi.KubeObject {
+  static kind = "Certificate"
+  static namespaced = true
+  static apiBase = "/apis/cert-manager.io/v1alpha2/certificates"
+
+  kind: string
+  apiVersion: string
+  metadata: {
+    name: string;
+    namespace: string;
+    selfLink: string;
+    uid: string;
+    resourceVersion: string;
+    creationTimestamp: string;
+    labels: {
+      [key: string]: string;
+    };
+    annotations: {
+      [key: string]: string;
+    };
+  }
+  spec: {
+    dnsNames: string[];
+    issuerRef: {
+      group: string;
+      kind: string;
+      name: string;
+    }
+    secretName: string
+  }
+  status: {
+    conditions: {
+      lastTransitionTime: string;
+      message: string;
+      reason: string;
+      status: string;
+      type?: string;
+    }[];
+  }
+}
+
+

With CertificatesApi class we are able to manage Certificate objects in Kubernetes API:

+
export class CertificatesApi extends K8sApi.KubeApi<Certificate> {
+}
+export const certificatesApi = new CertificatesApi({
+  objectConstructor: Certificate
+});
+
+

CertificateStore defines storage for Certificate objects

+
export class CertificatesStore extends K8sApi.KubeObjectStore<Certificate> {
+  api = certificatesApi
+}
+
+export const certificatesStore = new CertificatesStore();
+
+

And, finally, we register this store to Lens's API manager.

+
K8sApi.apiManager.registerStore(certificatesStore);
+
+

Create CertificatePage component#

+

Now we have created mechanism to manage Certificate objects in Kubernetes API. +Then we need to fetch those and render them in the UI.

+

First we define CertificatePage class that extends React.Component.

+
import { Component, LensRendererExtension } from "@k8slens/extensions";
+import React from "react";
+import { certificatesStore } from "../certificate-store";
+import { Certificate } from "../certificate"
+
+export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
+
+}
+
+

Next we will implement render method that will display certificates in a list. +To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. +To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. +Component.KubeObjectListLayout will fetch automatically 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.2.5/extensions/guides/main-extension/index.html b/v4.2.5/extensions/guides/main-extension/index.html new file mode 100644 index 0000000000..84c1e44b7a --- /dev/null +++ b/v4.2.5/extensions/guides/main-extension/index.html @@ -0,0 +1,1282 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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. +
  2. Click Disable on the extension you want to disable.
    3. +
+

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.2.5/extensions/guides/protocol-handlers/index.html b/v4.2.5/extensions/guides/protocol-handlers/index.html new file mode 100644 index 0000000000..c36a3bb5f0 --- /dev/null +++ b/v4.2.5/extensions/guides/protocol-handlers/index.html @@ -0,0 +1,1241 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Protocol Handlers - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Lens Protocol Handlers#

+

Lens has a file association with the lens:// protocol. +This means that Lens can be opened by external programs by providing a link that has lens as its protocol. +Lens provides a routing mechanism that extensions can use to register custom handlers.

+

Registering A Protocol Handler#

+

The field protocolHandlers exists both on LensMainExtension and on LensRendererExtension. +This field will be iterated through every time a lens:// request gets sent to the application. +The pathSchema argument must comply with the path-to-regexp package's compileToRegex function.

+

Once you have registered a handler it will be called when a user opens a link on their computer. +Handlers will be run in both main and renderer in parallel with no synchronization between the two processes. +Furthermore, both main and renderer are routed separately. +In other words, which handler is selected in either process is independent from the list of possible handlers in the other.

+

Example of registering a handler:

+
import { LensMainExtension, Interface } from "@k8slens/extensions";
+
+function rootHandler(params: Iterface.ProtocolRouteParams) {
+  console.log("routed to ExampleExtension", params);
+}
+
+export default class ExampleExtensionMain extends LensMainExtension {
+  protocolHandlers = [
+    pathSchema: "/",
+    handler: rootHandler,
+  ]
+}
+
+

For testing the routing of URIs the open (on macOS) or xdg-open (on most linux) CLI utilities can be used. +For the above handler, the following URI would be always routed to it:

+
open lens://extension/example-extension/
+
+

Deregistering A Protocol Handler#

+

All that is needed to deregister a handler is to remove it from the array of handlers.

+

Routing Algorithm#

+

The routing mechanism for extensions is quite straight forward. +For example consider an extension example-extension which is published by the @mirantis org. +If it were to register a handler with "/display/:type" as its corresponding link then we would match the following URI like this:

+

Lens Protocol Link Resolution

+

Once matched, the handler would be called with the following argument (note both "search" and "pathname" will always be defined):

+
{
+  "search": {
+    "text": "Hello"
+  },
+  "pathname": {
+    "type": "notification"
+  }
+}
+
+

As the diagram above shows, the search (or query) params are not considered as part of the handler resolution. +If the URI had instead been lens://extension/@mirantis/example-extension/display/notification/green then a third (and optional) field will have the rest of the path. +The tail field would be filled with "/green". +If multiple pathSchema's match a given URI then the most specific handler will be called.

+

For example consider the following pathSchema's:

+
    +
  1. "/"
    2. +
  2. "/display"
    3. +
  3. "/display/:type"
    4. +
  4. "/show/:id"
    5. +
+

The URI sub-path "/display" would be routed to #2 since it is an exact match. +On the other hand, the subpath "/display/notification" would be routed to #3.

+

The URI is routed to the most specific matching pathSchema. +This way the "/" (root) pathSchema acts as a sort of catch all or default route if no other route matches.

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/guides/renderer-extension/index.html b/v4.2.5/extensions/guides/renderer-extension/index.html new file mode 100644 index 0000000000..0b5cbd7c2a --- /dev/null +++ b/v4.2.5/extensions/guides/renderer-extension/index.html @@ -0,0 +1,2122 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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. +
  2. Click Disable on the extension you want to disable.
    3. +
+
+

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.2.5/extensions/guides/stores/index.html b/v4.2.5/extensions/guides/stores/index.html new file mode 100644 index 0000000000..afb72e6be9 --- /dev/null +++ b/v4.2.5/extensions/guides/stores/index.html @@ -0,0 +1,1294 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/guides/working-with-mobx/index.html b/v4.2.5/extensions/guides/working-with-mobx/index.html new file mode 100644 index 0000000000..9c069c317b --- /dev/null +++ b/v4.2.5/extensions/guides/working-with-mobx/index.html @@ -0,0 +1,1186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/index.html b/v4.2.5/extensions/index.html new file mode 100644 index 0000000000..08bd63667a --- /dev/null +++ b/v4.2.5/extensions/index.html @@ -0,0 +1,1239 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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. +To install your first extension you should goto the extension page in lens.

+

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.2.5/extensions/testing-and-publishing/bundling/index.html b/v4.2.5/extensions/testing-and-publishing/bundling/index.html new file mode 100644 index 0000000000..da62a487d8 --- /dev/null +++ b/v4.2.5/extensions/testing-and-publishing/bundling/index.html @@ -0,0 +1,1038 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Bundling - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+ + + + +

Bundling

+ + + + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/extensions/testing-and-publishing/publishing/index.html b/v4.2.5/extensions/testing-and-publishing/publishing/index.html new file mode 100644 index 0000000000..1c15a0e53b --- /dev/null +++ b/v4.2.5/extensions/testing-and-publishing/publishing/index.html @@ -0,0 +1,1235 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/extensions/testing-and-publishing/testing/index.html b/v4.2.5/extensions/testing-and-publishing/testing/index.html new file mode 100644 index 0000000000..d3186359a6 --- /dev/null +++ b/v4.2.5/extensions/testing-and-publishing/testing/index.html @@ -0,0 +1,1294 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Testing Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+
+ + + + +

Testing Extensions#

+

Renderer Process Unit Testing#

+

UI components in the extension's 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 then the testing environment for render process is already set up 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's main process consists of normal JavaScript files that have 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 then the Jest testing environment is set up 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.2.5/extensions/typedoc-readme.md.tpl b/v4.2.5/extensions/typedoc-readme.md.tpl new file mode 100644 index 0000000000..6e23d197d5 --- /dev/null +++ b/v4.2.5/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.2.5/extensions/usage/images/extensions.png b/v4.2.5/extensions/usage/images/extensions.png new file mode 100644 index 0000000000..5deb8e4bd2 Binary files /dev/null and b/v4.2.5/extensions/usage/images/extensions.png differ diff --git a/v4.2.5/extensions/usage/index.html b/v4.2.5/extensions/usage/index.html new file mode 100644 index 0000000000..46255fd9d2 --- /dev/null +++ b/v4.2.5/extensions/usage/index.html @@ -0,0 +1,1193 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/faq/index.html b/v4.2.5/faq/index.html new file mode 100644 index 0000000000..ed704f1d13 --- /dev/null +++ b/v4.2.5/faq/index.html @@ -0,0 +1,1307 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/getting-started/images/color-theme.png b/v4.2.5/getting-started/images/color-theme.png new file mode 100644 index 0000000000..5e4f144560 Binary files /dev/null and b/v4.2.5/getting-started/images/color-theme.png differ diff --git a/v4.2.5/getting-started/images/disabled-telemetry-usage-tracking.png b/v4.2.5/getting-started/images/disabled-telemetry-usage-tracking.png new file mode 100644 index 0000000000..809a96056a Binary files /dev/null and b/v4.2.5/getting-started/images/disabled-telemetry-usage-tracking.png differ diff --git a/v4.2.5/getting-started/images/snap-store.png b/v4.2.5/getting-started/images/snap-store.png new file mode 100644 index 0000000000..5e652132c3 Binary files /dev/null and b/v4.2.5/getting-started/images/snap-store.png differ diff --git a/v4.2.5/getting-started/index.html b/v4.2.5/getting-started/index.html new file mode 100644 index 0000000000..94eb318fb9 --- /dev/null +++ b/v4.2.5/getting-started/index.html @@ -0,0 +1,1299 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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. +
  2. Open the browser's download list and locate the downloaded archive.
    3. +
  3. Select the 'magnifying glass' icon to open the archive in Finder.
    4. +
  4. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad.
    5. +
  5. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options, Keep in Dock.
    6. +
+

Windows#

+
    +
  1. Download the Lens installer for Windows.
    2. +
  2. Once it is downloaded, run the installer Lens-Setup-{version}.exe. This will only take a minute.
    3. +
  3. By default, Lens is installed under C:\users\{username}\AppData\Local\Programs\Lens.
    4. +
+

Linux#

+

See the Download Lens page for a complete list of available installation options.

+

After installing Lens manually (not using a package manager file such as .deb or .rpm) the following will need to be done to allow protocol handling. +This assumes that your linux distribution uses xdg-open and the xdg-* suite of programs for determining which application can handle custom URIs.

+
    +
  1. Create a file called lens.desktop in either ~/.local/share/applications/ or /usr/share/applications (if you have permissions and are installing Lens for all users).
    2. +
  2. That file should have the following contents, with <path/to/executable> being the absolute path to where you have installed the unpacked Lens executable: + 
    [Desktop Entry]
+Name=Lens
+Exec=<path/to/executable> %U
+Terminal=false
+Type=Application
+Icon=lens
+StartupWMClass=Lens
+Comment=Lens - The Kubernetes IDE
+MimeType=x-scheme-handler/lens;
+Categories=Network;
+
    3. +
  3. Then run the following command: + 
    xdg-settings set default-url-scheme-handler lens lens.desktop
+
    4. +
  4. If that succeeds (exits with code 0) then your Lens install should be set up to handle lens:// URIs.
    5. +
+

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.2.5/getting-started/introductory-videos/index.html b/v4.2.5/getting-started/introductory-videos/index.html new file mode 100644 index 0000000000..14eb46a5c7 --- /dev/null +++ b/v4.2.5/getting-started/introductory-videos/index.html @@ -0,0 +1,1091 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Introductory Videos - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + +
+
+
+ + + +
+
+
+ + +
+
+
+ + +
+ + +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/getting-started/preferences/index.html b/v4.2.5/getting-started/preferences/index.html new file mode 100644 index 0000000000..30ea21092b --- /dev/null +++ b/v4.2.5/getting-started/preferences/index.html @@ -0,0 +1,1206 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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). Or follow this link.
    2. +
  2. Select your preferred theme from the Color Theme dropdown. +Color Theme
    3. +
+

Telemetry & Usage Tracking#

+

Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.

+

Disable Telemetry Reporting#

+

If you don't wish to send usage data to Mirantis, you can disable the "Telemetry & Usage Tracking" in the Lens preferences.

+
    +
  1. Go to File > Preferences (Lens > Preferences on Mac). Or follow this link.
    2. +
  2. Scroll down to Telemetry & Usage Tracking
    3. +
  3. Uncheck Allow Telemetry & Usage Tracking.
    4. +
+

This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting. +Disable Telemetry & Usage Tracking

+ + + + + + + +
+ +
+
+ +
+ + + + +
+
+
+
+ + + + + + + + \ No newline at end of file diff --git a/v4.2.5/helm/images/helm-charts.png b/v4.2.5/helm/images/helm-charts.png new file mode 100644 index 0000000000..93548fca9e Binary files /dev/null and b/v4.2.5/helm/images/helm-charts.png differ diff --git a/v4.2.5/helm/index.html b/v4.2.5/helm/index.html new file mode 100644 index 0000000000..0ca44e7928 --- /dev/null +++ b/v4.2.5/helm/index.html @@ -0,0 +1,1200 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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 Repositories#

+

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.2.5/img/favicon.ico b/v4.2.5/img/favicon.ico new file mode 100644 index 0000000000..19b2de71d1 Binary files /dev/null and b/v4.2.5/img/favicon.ico differ diff --git a/v4.2.5/img/lens-intro-video-screenshot.png b/v4.2.5/img/lens-intro-video-screenshot.png new file mode 100644 index 0000000000..2c5467b3f0 Binary files /dev/null and b/v4.2.5/img/lens-intro-video-screenshot.png differ diff --git a/v4.2.5/img/lens-logo-icon.svg b/v4.2.5/img/lens-logo-icon.svg new file mode 100644 index 0000000000..ede39244e5 --- /dev/null +++ b/v4.2.5/img/lens-logo-icon.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + diff --git a/v4.2.5/img/play.svg b/v4.2.5/img/play.svg new file mode 100644 index 0000000000..a94d6e88ab --- /dev/null +++ b/v4.2.5/img/play.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v4.2.5/index.html b/v4.2.5/index.html new file mode 100644 index 0000000000..c422a06cdc --- /dev/null +++ b/v4.2.5/index.html @@ -0,0 +1,1160 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 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.2.5/search/search_index.json b/v4.2.5/search/search_index.json new file mode 100644 index 0000000000..4f74989115 --- /dev/null +++ b/v4.2.5/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview # Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab Downloading Lens # Download Lens for macOS, Windows, or Linux. Quick Start # Get up and running quickly by learning to add clusters .","title":"Overview"},{"location":"#overview","text":"Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab","title":"Overview"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"#quick-start","text":"Get up and running quickly by learning to add clusters .","title":"Quick Start"},{"location":"clusters/adding-clusters/","text":"Adding Clusters # Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Or click here . Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app. Exec auth plugins # When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#adding-clusters","text":"Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Or click here . Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#exec-auth-plugins","text":"When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Exec auth plugins"},{"location":"clusters/removing-clusters/","text":"Removing Clusters # Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/removing-clusters/#removing-clusters","text":"Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/settings/","text":"Settings # It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings . Status # Overview of the cluster status Cluster Status # Cluster status information including the detected distribution, kernel version, API endpoint, and online status General # General cluster settings Cluster Name # The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file. Workspace # This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings. Cluster Icon # Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon. HTTP Proxy # Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so. Prometheus # Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide . Working Directory # Use this field to set the terminal working directory. The default is $HOME . Features # Additional Lens features that can be installed by the user Metrics # Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed. User Mode # User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces. Removal # Use this setting to remove the current cluster.","title":"Settings"},{"location":"clusters/settings/#settings","text":"It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings .","title":"Settings"},{"location":"clusters/settings/#status","text":"Overview of the cluster status","title":"Status"},{"location":"clusters/settings/#cluster-status","text":"Cluster status information including the detected distribution, kernel version, API endpoint, and online status","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"General cluster settings","title":"General"},{"location":"clusters/settings/#cluster-name","text":"The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide .","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"Use this field to set the terminal working directory. The default is $HOME .","title":"Working Directory"},{"location":"clusters/settings/#features","text":"Additional Lens features that can be installed by the user","title":"Features"},{"location":"clusters/settings/#metrics","text":"Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.","title":"Metrics"},{"location":"clusters/settings/#user-mode","text":"User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.","title":"User Mode"},{"location":"clusters/settings/#removal","text":"Use this setting to remove the current cluster.","title":"Removal"},{"location":"contributing/","text":"Contributing # There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word ! Code of Conduct # This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Overview"},{"location":"contributing/#contributing","text":"There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word !","title":"Contributing"},{"location":"contributing/#code-of-conduct","text":"This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Code of Conduct"},{"location":"contributing/development/","text":"Development # Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue. Recommended Reading: # TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs) Local Development Environment # Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts Developing on Windows # On Windows we only support Git Bash (or similar shell) for running commands. Github Workflow # We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow Code Testing # All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing License # By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"Development"},{"location":"contributing/development/#development","text":"Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.","title":"Development"},{"location":"contributing/development/#recommended-reading","text":"TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs)","title":"Recommended Reading:"},{"location":"contributing/development/#local-development-environment","text":"Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts","title":"Local Development Environment"},{"location":"contributing/development/#developing-on-windows","text":"On Windows we only support Git Bash (or similar shell) for running commands.","title":"Developing on Windows"},{"location":"contributing/development/#github-workflow","text":"We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow","title":"Github Workflow"},{"location":"contributing/development/#code-testing","text":"All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing","title":"Code Testing"},{"location":"contributing/development/#license","text":"By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"License"},{"location":"contributing/documentation/","text":"Documentation # We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source . Finding Documentation Issues to Work On # You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request. Requirements for Documentation Pull Requests # When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. Testing Documentation Site Locally # Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Documentation"},{"location":"contributing/documentation/#documentation","text":"We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source .","title":"Documentation"},{"location":"contributing/documentation/#finding-documentation-issues-to-work-on","text":"You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request.","title":"Finding Documentation Issues to Work On"},{"location":"contributing/documentation/#requirements-for-documentation-pull-requests","text":"When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.","title":"Requirements for Documentation Pull Requests"},{"location":"contributing/documentation/#testing-documentation-site-locally","text":"Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Testing Documentation Site Locally"},{"location":"contributing/github_workflow/","text":"Github Workflow # Fork The Project Adding the Forked Remote Create & Rebase Your Feature Branch Commit & Push Open a Pull Request Get a code review Squash commits Push Your Final Changes This guide assumes you have already cloned the upstream repo to your system via git clone. Fork The Project # Go to http://github.com/lensapp/lens On the top, right-hand side, click on \"fork\" and select your username for the fork destination. Adding the Forked Remote # export GITHUB_USER={ your github's username } cd $WORKDIR/lens git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git # Prevent push to Upstream git remote set-url --push origin no_push # Set your fork remote as a default push target git push --set-upstream $GITHUB_USER master Your remotes should look something like this: \u279c git remote -v origin https://github.com/lensapp/lens (fetch) origin no_push (push) my_fork git@github.com:{ github_username }/lens.git (fetch) my_fork git@github.com:{ github_username }/lens.git (push) Create & Rebase Your Feature Branch # Create a feature branch: git branch -b my_feature_branch Rebase your branch: git fetch origin git rebase origin/master Current branch my_feature_branch is up to date. Please don't use git pull instead of the above fetch / rebase . git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. Commit & Push # Commit and sign your changes: git commit -m \"my commit title\" --signoff You can go back and edit/build/test some more, then commit --amend in a few cycles. When ready, push your changes to your fork's repository: git push --set-upstream my_fork my_feature_branch Open a Pull Request # See Github Docs . Get a code review # Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. Commit changes made in response to review comments should be added to the same branch on your fork. Very small PRs are easy to review. Very large PRs are very difficult to review. Squashing Commits # Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. To do that, it's best to perform an interactive rebase : Example # If you PR has 3 commits, count backwards from your last commit using HEAD~3 : git rebase -i HEAD~3 Output would be similar to this: pick f7f3f6d Changed some code pick 310154e fixed some typos pick a5f4a0d made some review changes # Rebase 710f0f8..a5f4a0d onto 710f0f8 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like \"squash\", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # b, break = stop here (continue rebase later with 'git rebase --continue') # d, drop = remove commit # l, label